Skip to main content

Field

Struct Field 

Source
#[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: String

The field name.

§kind: Kind

The 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: bool

Whether 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

Source

pub fn new(name: &str, kind: Kind) -> Self

A field with no documentation or attributes.

Source

pub fn with_spare(self) -> Self

Marks the field spare: its bits carry no information.

Source

pub fn with_visibility(self, visibility: &str) -> Self

Sets the visibility, such as pub(crate) or "" for private.

Source

pub fn with_doc(self, doc: &str) -> Self

Sets the documentation.

Source

pub fn with_stated(self, stated: Stated) -> Self

Sets the #[at] position.

Source

pub fn with_magic(self, bytes: &[u8]) -> Self

Sets the #[magic] bytes.

Source

pub fn with_range(self, range: Range) -> Self

Sets the #[range].

Trait Implementations§

Source§

impl Clone for Field

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Field

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for Field

Source§

impl PartialEq for Field

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.