Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Definition::Enum::tag_width field #215

Merged
merged 3 commits into from
Sep 11, 2023
Merged

Add Definition::Enum::tag_width field #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0967d54
Add Definition::Enum::tag_width field
mina86 Sep 8, 2023
f237c55
build: revert externing `alloc` crate when `std` is available; fix te…
Sep 11, 2023
2adf4ca
chore: add `MaxSizeError::ZSTSequenceNotArray`
Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions borsh-derive/src/internals/schema/enums/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,10 @@ pub fn process(input: &ItemEnum, cratename: Path) -> syn::Result<TokenStream2> {
fn add_definitions_recursively(definitions: &mut #cratename::__private::maybestd::collections::BTreeMap<#cratename::schema::Declaration, #cratename::schema::Definition>) {
#inner_defs
#add_recursive_defs
let variants = #cratename::__private::maybestd::vec![#(#variants_defs),*];
let definition = #cratename::schema::Definition::Enum{variants};
let definition = #cratename::schema::Definition::Enum {
tag_width: 1,
variants: #cratename::__private::maybestd::vec![#(#variants_defs),*],
};
#cratename::schema::add_definition(Self::declaration(), definition, definitions);
}
};
Expand Down
12 changes: 6 additions & 6 deletions borsh-derive/src/internals/schema/enums/snapshots/complex_enum.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ impl borsh::BorshSchema for A {
<AEggs as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ASalad as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ASausage as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration()), ("Salad".to_string(), < ASalad > ::declaration()),
("Sausage".to_string(), < ASausage > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration()), ("Salad".to_string(), < ASalad >
::declaration()), ("Sausage".to_string(), < ASausage > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
13 changes: 7 additions & 6 deletions borsh-derive/src/internals/schema/enums/snapshots/complex_enum_generics.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,14 @@ where
<AEggs as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ASalad<C> as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ASausage<W> as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration()), ("Salad".to_string(), < ASalad < C > >
::declaration()), ("Sausage".to_string(), < ASausage < W > > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration()), ("Salad".to_string(), < ASalad < C > >
::declaration()), ("Sausage".to_string(), < ASausage < W > >
::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
14 changes: 7 additions & 7 deletions ...ve/src/internals/schema/enums/snapshots/complex_enum_generics_borsh_skip_named_field.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ where
<AEggs as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ASalad<C> as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ASausage<W, U> as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration()), ("Salad".to_string(), < ASalad < C > >
::declaration()), ("Sausage".to_string(), < ASausage < W, U > >
::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration()), ("Salad".to_string(), < ASalad < C > >
::declaration()), ("Sausage".to_string(), < ASausage < W, U > >
::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
13 changes: 7 additions & 6 deletions ...ve/src/internals/schema/enums/snapshots/complex_enum_generics_borsh_skip_tuple_field.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,14 @@ where
<AEggs as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ASalad<C> as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ASausage<W> as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration()), ("Salad".to_string(), < ASalad < C > >
::declaration()), ("Sausage".to_string(), < ASausage < W > > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration()), ("Salad".to_string(), < ASalad < C > >
::declaration()), ("Sausage".to_string(), < ASausage < W > >
::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
10 changes: 5 additions & 5 deletions borsh-derive/src/internals/schema/enums/snapshots/filter_foreign_attrs.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ impl borsh::BorshSchema for A {
}
<AB as borsh::BorshSchema>::add_definitions_recursively(definitions);
<ANegative as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("B".to_string(), < AB > ::declaration()), ("Negative".to_string(), <
ANegative > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("B".to_string(), < AB > ::declaration()), ("Negative".to_string(), <
ANegative > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
10 changes: 5 additions & 5 deletions borsh-derive/src/internals/schema/enums/snapshots/generic_associated_type.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ where
<EnumParametrizedC<
T,
> as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("B".to_string(), < EnumParametrizedB < K, V > > ::declaration()), ("C"
.to_string(), < EnumParametrizedC < T > > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("B".to_string(), < EnumParametrizedB < K, V > > ::declaration()), ("C"
.to_string(), < EnumParametrizedC < T > > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
10 changes: 5 additions & 5 deletions ...h-derive/src/internals/schema/enums/snapshots/generic_associated_type_param_override.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ where
<EnumParametrizedC<
T,
> as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("B".to_string(), < EnumParametrizedB < K, V > > ::declaration()), ("C"
.to_string(), < EnumParametrizedC < T > > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("B".to_string(), < EnumParametrizedB < K, V > > ::declaration()), ("C"
.to_string(), < EnumParametrizedC < T > > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
10 changes: 5 additions & 5 deletions borsh-derive/src/internals/schema/enums/snapshots/recursive_enum.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ where
struct AC<K: Key>(K, Vec<A>);
<AB<K, V> as borsh::BorshSchema>::add_definitions_recursively(definitions);
<AC<K> as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("B".to_string(), < AB < K, V > > ::declaration()), ("C".to_string(), < AC <
K > > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("B".to_string(), < AB < K, V > > ::declaration()), ("C".to_string(), <
AC < K > > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
10 changes: 5 additions & 5 deletions borsh-derive/src/internals/schema/enums/snapshots/simple_enum.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ impl borsh::BorshSchema for A {
struct AEggs;
<ABacon as borsh::BorshSchema>::add_definitions_recursively(definitions);
<AEggs as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
10 changes: 5 additions & 5 deletions borsh-derive/src/internals/schema/enums/snapshots/simple_enum_with_custom_crate.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ impl reexporter::borsh::BorshSchema for A {
<AEggs as reexporter::borsh::BorshSchema>::add_definitions_recursively(
definitions,
);
let variants = reexporter::borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration())
];
let definition = reexporter::borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: reexporter::borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration()), ("Eggs".to_string(), <
AEggs > ::declaration())
],
};
reexporter::borsh::schema::add_definition(
Self::declaration(),
Expand Down
8 changes: 4 additions & 4 deletions borsh-derive/src/internals/schema/enums/snapshots/single_field_enum.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ impl borsh::BorshSchema for A {
#[borsh(crate = "borsh")]
struct ABacon;
<ABacon as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("Bacon".to_string(), < ABacon > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
10 changes: 5 additions & 5 deletions borsh-derive/src/internals/schema/enums/snapshots/trailing_comma_generics.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ where
B: Display + Debug;
<SideLeft<A> as borsh::BorshSchema>::add_definitions_recursively(definitions);
<SideRight<B> as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("Left".to_string(), < SideLeft < A > > ::declaration()), ("Right"
.to_string(), < SideRight < B > > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("Left".to_string(), < SideLeft < A > > ::declaration()), ("Right"
.to_string(), < SideRight < B > > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
10 changes: 5 additions & 5 deletions borsh-derive/src/internals/schema/enums/snapshots/with_funcs_attr.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ where
);
<CC3 as borsh::BorshSchema>::add_definitions_recursively(definitions);
<CC4<K, V> as borsh::BorshSchema>::add_definitions_recursively(definitions);
let variants = borsh::__private::maybestd::vec![
("C3".to_string(), < CC3 > ::declaration()), ("C4".to_string(), < CC4 < K, V
> > ::declaration())
];
let definition = borsh::schema::Definition::Enum {
variants,
tag_width: 1,
variants: borsh::__private::maybestd::vec![
("C3".to_string(), < CC3 > ::declaration()), ("C4".to_string(), < CC4 <
K, V > > ::declaration())
],
};
borsh::schema::add_definition(Self::declaration(), definition, definitions);
}
Expand Down
72 changes: 56 additions & 16 deletions borsh/src/schema.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ pub type VariantName = String;
pub type FieldName = String;
/// The type that we use to represent the definition of the Borsh type.

/// Description of data encoding on the wire.
///
/// Note: Since at the end of the day users can define arbitrary serialisation,
/// it’s not always possible to express using definitions how a type is encoded.
/// For example, let’s say programmer uses [varint] encoding for their data.
/// Such type cannot be fully expressed using `BorshSchema` (or at least not
/// easily). As a consequence, a tool which validates whether binary data
/// matches a schema wouldn’t be able to validate data including such types.
///
/// [varint]: https://en.wikipedia.org/wiki/Variable-length_quantity#Variants
#[derive(Clone, PartialEq, Eq, Debug, BorshSerialize, BorshDeserialize, BorshSchemaMacro)]
pub enum Definition {
/// A fixed-size array with the length known at the compile time and the same-type elements.
Expand All @@ -44,10 +54,31 @@ pub enum Definition {
/// A fixed-size tuple with the length known at the compile time and the elements of different
/// types.
Tuple { elements: Vec<Declaration> },
/// A tagged union, a.k.a enum. Tagged-unions have variants with associated structures.

/// A possibly tagged union, a.k.a enum.
///
/// Tagged unions are prefixed by a tag identifying encoded variant followed
/// by encoding of that variant.
///
/// Untagged unions don’t have a separate tag which means that knowledge of
/// the type is necessary to fully analyse the binary. Variants may still
/// be used to list possible values or determine the longest possible
/// encoding.
Enum {
/// Width in bytes of the discriminant tag.
///
/// Zero indicates this is an untagged union. In standard borsh
/// encoding this is one. However custom encoding formats may use larger
/// width if they need to encode more than 256 variants.
///
/// Note: This definition must not be used if the tag is not encoded
/// using little-endian format.
tag_width: u8,

/// Possible variants of the enumeration.
variants: Vec<(VariantName, Declaration)>,
},

/// A structure, structurally similar to a tuple.
Struct { fields: Fields },
}
Expand Down Expand Up @@ -281,6 +312,7 @@ where
{
fn add_definitions_recursively(definitions: &mut BTreeMap<Declaration, Definition>) {
let definition = Definition::Enum {
tag_width: 1,
variants: vec![
("None".to_string(), <()>::declaration()),
("Some".to_string(), T::declaration()),
Expand All @@ -302,6 +334,7 @@ where
{
fn add_definitions_recursively(definitions: &mut BTreeMap<Declaration, Definition>) {
let definition = Definition::Enum {
tag_width: 1,
variants: vec![
("Ok".to_string(), T::declaration()),
("Err".to_string(), E::declaration()),
Expand Down Expand Up @@ -521,11 +554,14 @@ mod tests {
Option::<u64>::add_definitions_recursively(&mut actual_defs);
assert_eq!("Option<u64>", actual_name);
assert_eq!(
map! {"Option<u64>" =>
Definition::Enum{ variants: vec![
("None".to_string(), "nil".to_string()),
("Some".to_string(), "u64".to_string()),
]}
map! {
"Option<u64>" => Definition::Enum {
tag_width: 1,
variants: vec![
("None".to_string(), "nil".to_string()),
("Some".to_string(), "u64".to_string()),
]
}
},
actual_defs
);
Expand All @@ -539,16 +575,20 @@ mod tests {
assert_eq!("Option<Option<u64>>", actual_name);
assert_eq!(
map! {
"Option<u64>" =>
Definition::Enum {variants: vec![
("None".to_string(), "nil".to_string()),
("Some".to_string(), "u64".to_string()),
]},
"Option<Option<u64>>" =>
Definition::Enum {variants: vec![
("None".to_string(), "nil".to_string()),
("Some".to_string(), "Option<u64>".to_string()),
]}
"Option<u64>" => Definition::Enum {
tag_width: 1,
variants: vec![
("None".to_string(), "nil".to_string()),
("Some".to_string(), "u64".to_string()),
]
},
"Option<Option<u64>>" => Definition::Enum {
tag_width: 1,
variants: vec![
("None".to_string(), "nil".to_string()),
("Some".to_string(), "Option<u64>".to_string()),
]
}
},
actual_defs
);
Expand Down
Loading