Struct gvariant::aligned_bytes::AlignedOffset

pub struct AlignedOffset<A: Alignment>(_, _)
 where
    Self: BitOr,
    Self::Output: Into<Self>;

Represents a usize that is some multiple of Alignment::ALIGNMENT.

AlignedOffset<A2> is essentially a usize that is multiple of 2. This is useful because you can slice a AlignedSlice<A2> and be statically guaranteed that the slice will still be aligned.

Use .try_new(), <usize>.try_into() or align_offset() to construct values of this type.

Implementations

impl<A: Alignment> AlignedOffset<A>

pub fn to_usize(&self) -> usize

Convert to usize

pub fn try_new(value: usize) -> Result<Self, Misaligned>

Construct an AlignedOffset from a usize.

Result will be Err(Misaligned) if the passed value is not a multiple of the alignment of this type. This is provided in addition to the TryInto impl because there is less scope for type ambiguity with this function.

Trait Implementations

impl<A: Alignment> BitOr<AlignedOffset<A>> for AlignedOffset<A>

type Output = AlignedOffset<A>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr<AlignedOffset<A1>> for AlignedOffset<A2>

type Output = AlignedOffset<A1>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A1>) -> AlignedOffset<A1>

Performs the | operation.

impl BitOr<AlignedOffset<A1>> for AlignedOffset<A4>

type Output = AlignedOffset<A1>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A1>) -> AlignedOffset<A1>

Performs the | operation.

impl BitOr<AlignedOffset<A1>> for AlignedOffset<A8>

type Output = AlignedOffset<A1>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A1>) -> AlignedOffset<A1>

Performs the | operation.

impl BitOr<AlignedOffset<A2>> for AlignedOffset<A1>

type Output = AlignedOffset<A1>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A2>) -> AlignedOffset<A1>

Performs the | operation.

impl BitOr<AlignedOffset<A2>> for AlignedOffset<A4>

type Output = AlignedOffset<A2>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A2>) -> AlignedOffset<A2>

Performs the | operation.

impl BitOr<AlignedOffset<A2>> for AlignedOffset<A8>

type Output = AlignedOffset<A2>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A2>) -> AlignedOffset<A2>

Performs the | operation.

impl BitOr<AlignedOffset<A4>> for AlignedOffset<A1>

type Output = AlignedOffset<A1>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A4>) -> AlignedOffset<A1>

Performs the | operation.

impl BitOr<AlignedOffset<A4>> for AlignedOffset<A2>

type Output = AlignedOffset<A2>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A4>) -> AlignedOffset<A2>

Performs the | operation.

impl BitOr<AlignedOffset<A4>> for AlignedOffset<A8>

type Output = AlignedOffset<A4>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A4>) -> AlignedOffset<A4>

Performs the | operation.

impl BitOr<AlignedOffset<A8>> for AlignedOffset<A1>

type Output = AlignedOffset<A1>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A8>) -> AlignedOffset<A1>

Performs the | operation.

impl BitOr<AlignedOffset<A8>> for AlignedOffset<A2>

type Output = AlignedOffset<A2>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A8>) -> AlignedOffset<A2>

Performs the | operation.

impl BitOr<AlignedOffset<A8>> for AlignedOffset<A4>

type Output = AlignedOffset<A4>

The resulting type after applying the | operator.

fn bitor(self, rhs: AlignedOffset<A8>) -> AlignedOffset<A4>

Performs the | operation.

impl<A: Alignment> Borrow<usize> for AlignedOffset<A>

fn borrow(&self) -> &usize

Immutably borrows from an owned value.

impl<A: Clone + Alignment> Clone for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

fn clone(&self) -> AlignedOffset<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Copy + Alignment> Copy for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

impl<A: Debug + Alignment> Debug for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

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

Formats the value using the given formatter.

impl<A: Alignment> Display for AlignedOffset<A>

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

Formats the value using the given formatter.

impl<A: Eq + Alignment> Eq for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

impl<A: Alignment> From<AlignedOffset<A>> for usize

fn from(value: AlignedOffset<A>) -> Self

Performs the conversion.

impl From<AlignedOffset<A2>> for AlignedOffset<A1>

fn from(v: AlignedOffset<A2>) -> Self

Performs the conversion.

impl From<AlignedOffset<A4>> for AlignedOffset<A1>

fn from(v: AlignedOffset<A4>) -> Self

Performs the conversion.

impl From<AlignedOffset<A4>> for AlignedOffset<A2>

fn from(v: AlignedOffset<A4>) -> Self

Performs the conversion.

impl From<AlignedOffset<A8>> for AlignedOffset<A1>

fn from(v: AlignedOffset<A8>) -> Self

Performs the conversion.

impl From<AlignedOffset<A8>> for AlignedOffset<A2>

fn from(v: AlignedOffset<A8>) -> Self

Performs the conversion.

impl From<AlignedOffset<A8>> for AlignedOffset<A4>

fn from(v: AlignedOffset<A8>) -> Self

Performs the conversion.

impl<A: Ord + Alignment> Ord for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

fn cmp(&self, other: &AlignedOffset<A>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<A: PartialEq + Alignment> PartialEq<AlignedOffset<A>> for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

fn eq(&self, other: &AlignedOffset<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &AlignedOffset<A>) -> bool

This method tests for !=.

impl<A: Alignment> PartialEq<AlignedOffset<A>> for usize

fn eq(&self, other: &AlignedOffset<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A: Alignment> PartialEq<usize> for AlignedOffset<A>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<A: PartialOrd + Alignment> PartialOrd<AlignedOffset<A>> for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

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

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

fn lt(&self, other: &AlignedOffset<A>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &AlignedOffset<A>) -> bool

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

fn gt(&self, other: &AlignedOffset<A>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &AlignedOffset<A>) -> bool

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

impl<A: Alignment> PartialOrd<AlignedOffset<A>> for usize

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<A: Alignment> PartialOrd<usize> for AlignedOffset<A>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<A: Alignment> StructuralEq for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

impl<A: Alignment> StructuralPartialEq for AlignedOffset<A> where
    Self: BitOr,
    Self::Output: Into<Self>, 

impl<A: Alignment> TryFrom<usize> for AlignedOffset<A>

type Error = Misaligned

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.