Struct EndianPrimitive

#[repr(C)]
pub struct EndianPrimitive<B, T: EndianConvert, Alignment = ()> { /* private fields */ }

A POD container for a primitive that stores a value in the specified endianness in memory, and transforms on get/set

Implementations

impl<B: ByteOrder, T: EndianConvert, A> EndianPrimitive<B, T, A>

pub fn new(v: T) -> Self

Creates a new value

pub fn get(&self) -> T

Transforms to the native value

pub fn set(&mut self, v: T)

Transforms from a native value

pub fn raw(&self) -> &T::Unaligned

Gets the inner untransformed value

pub fn raw_mut(&mut self) -> &mut T::Unaligned

A mutable reference to the inner untransformed value

Trait Implementations

impl<B, T: EndianConvert, A> Clone for EndianPrimitive<B, T, A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: ByteOrder, T: Debug + EndianConvert, A> Debug for EndianPrimitive<B, T, A>

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

Formats the value using the given formatter.

impl<B: ByteOrder, T: Default + EndianConvert, A> Default for EndianPrimitive<B, T, A>

fn default() -> Self

Returns the “default value” for a type.

impl<B: ByteOrder, T: EndianConvert, A> From<T> for EndianPrimitive<B, T, A>

fn from(v: T) -> Self

Converts to this type from the input type.

impl<B, T: EndianConvert + Hash, A> Hash for EndianPrimitive<B, T, A>

where T::Unaligned: Hash,

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

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<T, B: ByteOrder, A> Into<*const T> for EndianPrimitive<B, *const T, A>

fn into(self) -> *const T

Converts this type into the (usually inferred) input type.

impl<T, B: ByteOrder, A> Into<*mut T> for EndianPrimitive<B, *mut T, A>

fn into(self) -> *mut T

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<bool> for EndianPrimitive<B, bool, A>

fn into(self) -> bool

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<f32> for EndianPrimitive<B, f32, A>

fn into(self) -> f32

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<f64> for EndianPrimitive<B, f64, A>

fn into(self) -> f64

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<i16> for EndianPrimitive<B, i16, A>

fn into(self) -> i16

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<i32> for EndianPrimitive<B, i32, A>

fn into(self) -> i32

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<i64> for EndianPrimitive<B, i64, A>

fn into(self) -> i64

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<isize> for EndianPrimitive<B, isize, A>

fn into(self) -> isize

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<u16> for EndianPrimitive<B, u16, A>

fn into(self) -> u16

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<u32> for EndianPrimitive<B, u32, A>

fn into(self) -> u32

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<u64> for EndianPrimitive<B, u64, A>

fn into(self) -> u64

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, A> Into<usize> for EndianPrimitive<B, usize, A>

fn into(self) -> usize

Converts this type into the (usually inferred) input type.

impl<B: ByteOrder, T: EndianConvert + Ord, A> Ord for EndianPrimitive<B, T, A>

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<ARHS, A, BRHS: ByteOrder, RHS: EndianConvert, B: ByteOrder, T: EndianConvert + PartialEq<RHS>> PartialEq<EndianPrimitive<BRHS, RHS, ARHS>> for EndianPrimitive<B, T, A>

fn eq(&self, other: &EndianPrimitive<BRHS, RHS, ARHS>) -> 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<ARHS, A, BRHS: ByteOrder, RHS: EndianConvert, B: ByteOrder, T: EndianConvert + PartialOrd<RHS>> PartialOrd<EndianPrimitive<BRHS, RHS, ARHS>> for EndianPrimitive<B, T, A>

fn partial_cmp( &self, other: &EndianPrimitive<BRHS, RHS, ARHS>, ) -> 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<B: Pod, T: EndianConvert, A> Pod for EndianPrimitive<B, T, A>

unsafe fn uninitialized() -> Self

Generates a new uninitialized instance of a POD type.

fn zeroed() -> Self

Creates a new zeroed instance of a POD type.

fn copy(&self) -> Self

Creates a copy of this POD instance

fn map<T>(&self) -> Option<&T>

where T: Pod,

Converts a POD reference from one to another type of the same size.

fn map_mut<T>(&mut self) -> Option<&mut T>

where T: Pod,

Converts a mutable POD reference from one to another type of the same size.

fn map_copy<T>(&self) -> Option<T>

where T: Pod,

Converts a POD type from one to another of the same size.

fn try_map<T>(&self) -> Option<&T>

where T: Pod,

Converts a POD reference from one to another type of the same or lesser size.

fn try_map_mut<T>(&mut self) -> Option<&mut T>

where T: Pod,

Converts a mutable POD reference from one to another type of the same or lesser size.

fn try_map_copy<T>(&self) -> Option<T>

where T: Pod,

Converts a POD type from one to another of the same or lesser size.

fn map_box<T>(self: Box<Self>) -> Result<Box<T>, Box<Self>>

where T: Pod,

Converts a boxed POD type from one to another of the same size.

fn split<T>(&self) -> Option<&[T]>

where T: Pod,

Converts a POD reference into a slice of another type.

fn split_mut<T>(&mut self) -> Option<&mut [T]>

where T: Pod,

Converts a mutable POD reference into a slice of another type.

fn try_split<T>(&self) -> &[T]

where T: Pod,

Converts a POD reference into a slice of another type.

fn try_split_mut<T>(&mut self) -> &mut [T]

where T: Pod,

Converts a mutable POD reference into a slice of another type.

fn split_box<T>(self: Box<Self>) -> Result<Box<[T]>, Box<Self>>

where T: Pod,

Converts a boxed POD object into a boxed slice of another type.

fn split_vec<T>(self: Box<Self>) -> Result<Vec<T>, Box<Self>>

where T: Pod,

Converts a boxed POD object into a vector of another type.

fn map_slice<T>(s: &[Self]) -> Option<&[T]>

where T: Pod,

Maps a POD slice from one type to another.

fn map_slice_mut<T>(s: &mut [Self]) -> Option<&mut [T]>

where T: Pod,

Maps a mutable POD slice from one type to another.

fn try_map_slice<T>(s: &[Self]) -> &[T]

where T: Pod,

Maps a POD slice from one type to another.

fn try_map_slice_mut<T>(s: &mut [Self]) -> &mut [T]

where T: Pod,

Maps a mutable POD slice from one type to another.

fn map_slice_box<T>(s: Box<[Self]>) -> Result<Box<[T]>, Box<[Self]>>

where T: Pod,

Maps a boxed POD slice from one type to another.

fn map_slice_vec<T>(s: Vec<Self>) -> Result<Vec<T>, Vec<Self>>

where T: Pod,

Maps a POD vector from one type to another.

fn merge<T>(s: &[Self]) -> Option<&T>

where T: Pod,

Converts a POD slice into another type.

fn merge_mut<T>(s: &mut [Self]) -> Option<&mut T>

where T: Pod,

Converts a mutable POD slice into another type.

fn merge_copy<T>(s: &[Self]) -> Option<T>

where T: Pod,

Converts a POD slice into another type.

fn try_merge<T>(s: &[Self]) -> Option<&T>

where T: Pod,

Converts a POD slice into another type.

fn try_merge_mut<T>(s: &mut [Self]) -> Option<&mut T>

where T: Pod,

Converts a mutable POD slice into another type.

fn try_merge_copy<T>(s: &[Self]) -> Option<T>

where T: Pod,

Converts a POD slice into another type.

fn merge_box<T>(s: Box<[Self]>) -> Result<Box<T>, Box<[Self]>>

where T: Pod,

Converts a boxed POD slice into another boxed type.

fn merge_vec<T>(s: Vec<Self>) -> Result<Box<T>, Vec<Self>>

where T: Pod,

Converts a POD vector into another boxed type.

unsafe fn from_ptr<T>(source: *const T) -> Self

Creates a new POD instance from an unaligned pointer.

fn from_ref<T>(p: &T) -> Option<Self>

where T: Pod,

Creates a new POD instance with the inverse of map_copy()

fn from_slice<T>(p: &[T]) -> Option<Self>

where T: Pod,

Creates a new POD instance with the inverse of merge_copy()

fn from_boxed_slice<T>(p: Box<[T]>) -> Result<Box<Self>, Box<[T]>>

where T: Pod,

Creates a new POD instance with the inverse of merge_box()

fn from_vec<T>(p: Vec<T>) -> Result<Box<Self>, Vec<T>>

where T: Pod,

Creates a new POD instance with the inverse of merge_vec()

fn slice_from_boxed_slice<T>(p: Box<[T]>) -> Result<Box<[Self]>, Box<[T]>>

where T: Pod,

Creates a new POD instance with the inverse of map_slice_box()

fn ref_from<T>(p: &T) -> Option<&Self>

where T: Pod,

Creates a POD reference with the inverse of map()

fn ref_from_mut<T>(p: &mut T) -> Option<&mut Self>

where T: Pod,

Creates a mutable POD reference with the inverse of map_mut()

fn ref_from_slice<T>(p: &[T]) -> Option<&Self>

where T: Pod,

Creates a POD reference with the inverse of merge()

fn ref_from_slice_mut<T>(p: &mut [T]) -> Option<&mut Self>

where T: Pod,

Creates a mutable POD reference with the inverse of merge_mut()

fn as_bytes(&self) -> &[u8]

Borrows the POD as a byte slice

fn as_bytes_mut(&mut self) -> &mut [u8]

Borrows the POD as a mutable byte slice

fn from_bytes(p: &[u8]) -> Option<Self>

Safely creates a POD value from a potentially unaligned slice

fn ref_from_bytes(p: &[u8]) -> Option<&Self>

Borrows a new instance of the POD from a byte slice

fn ref_from_bytes_mut(p: &mut [u8]) -> Option<&mut Self>

Borrows a mutable instance of the POD from a mutable byte slice

fn from_byte_slice(p: Box<[u8]>) -> Result<Box<Self>, Box<[u8]>>

Converts a boxed slice to a boxed instance of the POD type

fn from_byte_vec(p: Vec<u8>) -> Result<Box<Self>, Vec<u8>>

Converts a byte vector to a boxed instance of the POD type

fn into_byte_slice(self: Box<Self>) -> Box<[u8]>

Converts a boxed POD to a boxed slice

fn into_byte_vec(self: Box<Self>) -> Vec<u8>

Converts a boxed POD to a byte vector

fn as_aligned_mut<T>(&mut self) -> Option<&mut T>

where T: Pod + Aligned<Unaligned = Self>, Self: Copy + Unaligned,

Safely borrows the aligned value mutably

impl<B, T: EndianConvert, A: Copy> Copy for EndianPrimitive<B, T, A>

impl<A, B: ByteOrder, T: EndianConvert + Eq> Eq for EndianPrimitive<B, T, A>

impl<B, T: EndianConvert, A: Unaligned> Packed for EndianPrimitive<B, T, A>

impl<B, T: EndianConvert, A: Unaligned> Unaligned for EndianPrimitive<B, T, A>