Struct hash40::Hash40

#[repr(transparent)]
pub struct Hash40(pub u64);

The central type of the crate, representing a string hashed using the hash40 algorithm Hash40 is a combination of a crc32 checksum and string length appended to the top bits

Tuple Fields

0: u64

Implementations

impl Hash40

pub const fn new(string: &str) -> Self

Computes a Hash40 from a string. This method does not respect the static label map, nor does it check to see if the provided string is in hexadecimal format already.

pub fn from_hex_str(value: &str) -> Result<Self, ParseHashError>

Converts a hexadecimal string representation of a hash to a Hash40

pub fn from_label(label: &str) -> Result<Self, FromLabelError>

Computes a Hash40 from a string. This method checks if the string is a hexadecimal value first. If not, it either searches for a reverse label from the static map or computes a new hash, depending on the form of the static label map.

pub fn to_label(&self) -> String

Searches for the label associated with the hash value. If no label is found, returns the hexadecimal value, formatted as 0x0123456789

pub const fn crc(self) -> u32

Returns the CRC32 part of the hash

pub const fn str_len(self) -> u8

Returns the string length part of the hash

pub fn label_map() -> Arc<Mutex<LabelMap>>

A convenience method provided to access the static label map

pub const fn concat(self, other: Self) -> Self

Concatenates two Hash40 values, so that the resulting length and CRC would be the same if the original data was all hashed together.

pub const fn concat_str(self, other: &str) -> Self

A convenience method for concatenating a string to a Hash40

pub const fn join_path(self, other: Self) -> Self

A convenience method for concatenating two Hash40s separated by a path separator

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 BinRead for Hash40

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_> ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

fn after_parse<R>( &mut self, _: &mut R, _: Endian, _: Self::Args<'_> ) -> Result<(), Error>where R: Read + Seek,

Runs any post-processing steps required to finalize construction of the object.

impl BinWrite for Hash40

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_> ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_> ) -> Result<(), Error>where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_> ) -> Result<(), Error>where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

impl Clone for Hash40

fn clone(&self) -> Hash40

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hash40

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

Formats the value using the given formatter.

impl Default for Hash40

fn default() -> Hash40

Returns the “default value” for a type.

impl Deref for Hash40

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Hash40

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Hash40

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Diff for Hash40

type Repr = Option<Hash40>

The type associated with the structs’ difference

fn diff(&self, other: &Self) -> Self::Repr

Produces a diff between two structs

fn apply(&mut self, diff: &Self::Repr)

Applies the diff directly to the struct

fn identity() -> Self

The identity element of the struct

fn diff_custom<D>(&self, other: &Self, visitor: &D) -> <D as Differ<Self>>::Reprwhere D: Differ<Self>,

Produces a diff between two structs, using an external diffing implementation

fn apply_custom<D>(&mut self, diff: &<D as Differ<Self>>::Repr, visitor: &D)where D: Differ<Self>,

Applies the diff directly to the struct, using an external diffing implementation

fn apply_new(&self, diff: &Self::Repr) -> Self

Applies the diff to the struct and produces a new struct

fn apply_new_custom<D>( &self, diff: &<D as Differ<Self>>::Repr, visitor: &D ) -> Selfwhere D: Differ<Self>,

Applies the diff to the struct and produces a new struct, using an external diffing implementation

impl Display for Hash40

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

Formats the value using the given formatter.

impl FromStr for Hash40

type Err = FromLabelError

The associated error which can be returned from parsing.

fn from_str(f: &str) -> Result<Self, FromLabelError>

Parses a string s to return a value of this type.

impl Hash for Hash40

fn hash<__H: Hasher>(&self, state: &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 Ord for Hash40

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Hash40> for Hash40

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

fn partial_cmp(&self, other: &Hash40) -> 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 Serialize for Hash40

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for Hash40

impl Eq for Hash40

impl StructuralEq for Hash40

impl StructuralPartialEq for Hash40