#[non_exhaustive]pub struct Field {
pub name: String,
pub kind: Kind,
pub doc: Option<String>,
pub stated: Option<Stated>,
pub magic: Option<Vec<u8>>,
pub range: Option<Range>,
pub spare: bool,
pub visibility: Option<String>,
}Expand description
A named field.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: StringThe field name.
kind: KindThe type and width.
doc: Option<String>Documentation.
stated: Option<Stated>The #[at] position.
magic: Option<Vec<u8>>The #[magic] bytes the field must hold.
range: Option<Range>The #[range] of allowed values.
spare: boolWhether the field is spare: bits the format reserves that carry no information.
The bits round-trip like any other field. Serde leaves a spare field out, under the same
cfg as the module’s serde derive.
visibility: Option<String>The field’s visibility, such as pub(crate). None is pub.
A field the generated type keeps in step with something else, such as a label that a catalogue arm already decided, is not the caller’s to set.
Implementations§
Source§impl Field
impl Field
Sourcepub fn with_spare(self) -> Self
pub fn with_spare(self) -> Self
Marks the field spare: its bits carry no information.
Sourcepub fn with_visibility(self, visibility: &str) -> Self
pub fn with_visibility(self, visibility: &str) -> Self
Sets the visibility, such as pub(crate) or "" for private.
Sourcepub fn with_stated(self, stated: Stated) -> Self
pub fn with_stated(self, stated: Stated) -> Self
Sets the #[at] position.
Sourcepub fn with_magic(self, bytes: &[u8]) -> Self
pub fn with_magic(self, bytes: &[u8]) -> Self
Sets the #[magic] bytes.
Sourcepub fn with_range(self, range: Range) -> Self
pub fn with_range(self, range: Range) -> Self
Sets the #[range].
Trait Implementations§
impl Eq for Field
impl StructuralPartialEq for Field
Auto Trait Implementations§
impl Freeze for Field
impl RefUnwindSafe for Field
impl Send for Field
impl Sync for Field
impl Unpin for Field
impl UnsafeUnpin for Field
impl UnwindSafe for Field
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more