Struct Offset

pub struct Offset<Base, Field> { /* private fields */ }

An offset, representing a value of type Field into a value of type Base.

The value of the offset is internally stored as an u32, so you are on your own if you try to use that crate with a struct larger than 4 GiB.

Offsets can be added together as long as their types correspond, i.e. it is possible to add an Offset<B, C> to an Offset<A, B> to get an Offset<A, C>.

Implementations

impl<Base, Field> Offset<Base, Field>

pub const unsafe fn new_unchecked(value: u32) -> Self

Creates a new arbitrary offset.

Safety

There must be a value of type Field at value bytes away from the start of a value of type Base.

pub const fn uninit(self) -> Offset<MaybeUninit<Base>, MaybeUninit<Field>>

Returns an offset suitable to be used with values of type MaybeUninit<Base>.

pub const fn as_u32(self) -> u32

Returns the offset as an u32.

This method provides the same functionality as From<Self> for u32 but is usable in const code.

pub fn index_in(self, base: &Base) -> &Field

Returns a reference to the value of type Field in base at this offset.

pub fn index_mut_in(self, base: &mut Base) -> &mut Field

Returns a mutable reference to the value of type Field in base at this offset.

Trait Implementations

impl<A, B, C> Add<Offset<B, C>> for Offset<A, B>

type Output = Offset<A, C>

The resulting type after applying the + operator.

fn add(self, other: Offset<B, C>) -> Self::Output

Performs the + operation.

impl<Base, Field> Binary for Offset<Base, Field>

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

Formats the value using the given formatter.

impl<Base, Field> Clone for Offset<Base, Field>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Base, Field> Debug for Offset<Base, Field>

where Base: DescribeOffset,

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

Formats the value using the given formatter.

impl<Base, Field> Display for Offset<Base, Field>

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

Formats the value using the given formatter.

impl<Base, Field> From<Offset<Base, Field>> for u32

fn from(offset: Offset<Base, Field>) -> Self

Converts to this type from the input type.

impl<Base, Field> Hash for Offset<Base, Field>

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<Base, Field> LowerHex for Offset<Base, Field>

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

Formats the value using the given formatter.

impl<Base, Field> Octal for Offset<Base, Field>

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

Formats the value using the given formatter.

impl<Base, Field> Ord for Offset<Base, Field>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Base, Field> PartialEq<&Offset<Base, Field>> for Offset<Base, Field>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Base, Field> PartialEq<&u32> for Offset<Base, Field>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Base, Field> PartialEq<u32> for Offset<Base, Field>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Base, Field> PartialEq for Offset<Base, Field>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Base, Field> PartialOrd<&Offset<Base, Field>> for Offset<Base, Field>

fn partial_cmp(&self, other: &&Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Base, Field> PartialOrd<&u32> for Offset<Base, Field>

fn partial_cmp(&self, other: &&u32) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Base, Field> PartialOrd<u32> for Offset<Base, Field>

fn partial_cmp(&self, other: &u32) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Base, Field> PartialOrd for Offset<Base, Field>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Base, Field> UpperHex for Offset<Base, Field>

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

Formats the value using the given formatter.

impl<Base, Field> Copy for Offset<Base, Field>

impl<Base, Field> Eq for Offset<Base, Field>

impl<Base, Field> Send for Offset<Base, Field>

impl<Base, Field> Sync for Offset<Base, Field>