Struct hff_std::Ecc

#[repr(C)]
pub struct Ecc(/* private fields */);

8 character code.

Implementations

impl Ecc

pub const SIZE: usize = 8usize

Constant representing the size of the structure.

pub const INVALID: Ecc = _

Constant representing an invalid Ecc.

pub const HFF_MAGIC: Ecc = _

The file header magic value.

pub const fn new(name: &str) -> Ecc

Create a new identifier. Panics if the provided string is empty or if the number of ‘bytes’ which represent the string won’t fit into a u64. i.e. the utf8 representation must be less than 9 bytes.

pub fn is_valid(&self) -> bool

Check if the Ecc is valid or not.

pub fn endian(&self, rhs: Ecc) -> Option<Endian>

Compare the Ecc’s in two ways, native and opposing endians. If equivalent, returns Some with the endianess otherwise None. NOTE: Will panic if rhs is a symetric id where endian can not be detected.

pub const fn swap_bytes(&self) -> Ecc

Swap the endianess of the code.

pub const fn as_slice(&self) -> &[u8]

Get the Ecc as a slice.

pub fn as_slice_mut(&mut self) -> &mut [u8]

Get the Ecc as a mutable slice.

pub fn read<E>(reader: &mut dyn Read) -> Result<Ecc, Error>

where E: ByteOrder,

Read from a stream.

pub fn write<E>(self, writer: &mut dyn Write) -> Result<(), Error>

where E: ByteOrder,

Write to a stream.

Methods from Deref<Target = u64>

pub const MIN: u64 = 0u64

pub const MAX: u64 = 18_446_744_073_709_551_615u64

pub const BITS: u32 = 64u32

Trait Implementations

impl Clone for Ecc

fn clone(&self) -> Ecc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ecc

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

Formats the value using the given formatter.

impl Default for Ecc

fn default() -> Ecc

Returns the “default value” for a type.

impl Deref for Ecc

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &<Ecc as Deref>::Target

Dereferences the value.

impl DerefMut for Ecc

fn deref_mut(&mut self) -> &mut <Ecc as Deref>::Target

Mutably dereferences the value.

impl From<&str> for Ecc

fn from(value: &str) -> Ecc

Converts to this type from the input type.

impl From<[u8; 8]> for Ecc

fn from(value: [u8; 8]) -> Ecc

Converts to this type from the input type.

impl From<u64> for Ecc

fn from(value: u64) -> Ecc

Converts to this type from the input type.

impl Hash for Ecc

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 Ord for Ecc

fn cmp(&self, other: &Ecc) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Ecc

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

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

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

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

impl PartialOrd for Ecc

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

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

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

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

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

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

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

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

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 ToString for Ecc

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFrom<String> for Ecc

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Ecc, <Ecc as TryFrom<String>>::Error>

Performs the conversion.

impl Copy for Ecc

impl Eq for Ecc

impl StructuralPartialEq for Ecc