Skip to main content

Kind

Enum Kind 

Source
#[non_exhaustive]
pub enum Kind { Scalar(Scalar), Array(Scalar, Vec<usize>), Codec { ty: String, bits: u64, }, Nested { ty: String, bytes: usize, }, NestedArray { ty: String, bytes: usize, len: usize, }, Var { ty: String, }, Msg { ty: String, boxed: bool, with: Vec<String>, }, Checksum { repr: Scalar, algorithm: String, over: Coverage, }, Text { len: Len, codec: Option<String>, }, }
Expand description

A field’s type and width.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Scalar(Scalar)

A scalar.

§

Array(Scalar, Vec<usize>)

An array of scalars, outermost length first: [[f64; 3]; 2] is [2, 3].

§

Codec

A FieldCodec type.

Fields

§ty: String

The type path.

§bits: u64

The width in bits.

§

Nested

A nested layout.

Fields

§ty: String

The type path.

§bytes: usize

The size in bytes.

§

NestedArray

An array of nested layouts.

Fields

§ty: String

The element type path.

§bytes: usize

One element’s size in bytes.

§len: usize

The number of elements.

§

Var

A VarCodec type, whose size is read from the wire.

Fields

§ty: String

The type path.

§

Msg

A nested MessageDef.

Fields

§ty: String

The type path.

§boxed: bool

Whether the Rust field is a Box, as a type that contains itself needs.

§with: Vec<String>

The fields passed as the message’s needs, in order.

§

Checksum

A #[checksum(..)] field in a fixed layout.

Messages use Segment::Checksum.

Fields

§repr: Scalar

The integer type.

§algorithm: String

The path of the layline::Checksum algorithm.

§over: Coverage

The bytes it covers.

§

Text

A String.

Fields

§len: Len

The length in bytes.

§codec: Option<String>

The TextCodec type path. None is UTF-8.

Implementations§

Source§

impl Kind

Source

pub fn bytes(n: usize) -> Self

[u8; n].

Same as Array(Scalar::U(8), vec![n]), but describes as raw bytes.

Source

pub fn array(s: Scalar, len: usize) -> Self

[s; len].

Source

pub fn checksum(repr: Scalar, algorithm: &str, over: Coverage) -> Self

#[checksum(algorithm, over = ..)].

Source

pub fn bits(&self) -> Option<u64>

The width in bits, or None if the size is read from the wire.

Source

pub fn is_integer(&self) -> bool

Whether a count, length or offset can read its number from this field.

Source

pub fn describe(&self) -> &'static str

A short description for error messages, such as “an integer”.

Trait Implementations§

Source§

impl Clone for Kind

Source§

fn clone(&self) -> Kind

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 Kind

Source§

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

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

impl Eq for Kind

Source§

impl Hash for Kind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Kind

Source§

fn eq(&self, other: &Kind) -> 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 Kind

Auto Trait Implementations§

§

impl Freeze for Kind

§

impl RefUnwindSafe for Kind

§

impl Send for Kind

§

impl Sync for Kind

§

impl Unpin for Kind

§

impl UnsafeUnpin for Kind

§

impl UnwindSafe for Kind

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.