Struct Hash 

pub struct Hash {
    pub value: HashValue,
}

A Kind::Hash value: a hash and its stored width.

A Hash value occupies 4 or 8 bytes in a file. The property defines the width. A reader returns each value with the width that the file stores. The writer writes each value with the width of the value.

Examples

use ltk_hash::{BinHash, Hash as _, HashValue, HashWidth};
use ltk_meta::{property::values, traits::PropertyExt as _};

let narrow = values::Hash::new(BinHash::hash_str("weapon"));
assert_eq!(narrow.width(), HashWidth::W4);
assert_eq!(narrow.size_no_header(), 4);

let wide = values::Hash::new(HashValue::wide(0x5d07_ca0d_22ff_9588));
assert_eq!(wide.size_no_header(), 8);

Fields

value: HashValue

Implementations

impl Hash

pub fn new(value: impl Into<HashValue>) -> Self

pub fn from_reader_with_width<R: Read + ?Sized>( reader: &mut R, width: HashWidth, ) -> Result<Self, Error>

Reads a Hash value of width bytes.

Errors

Fails if reader returns an I/O error.

Methods from Deref<Target = HashValue>

pub fn as_u64(self) -> u64

Returns the hash, zero-extended to 64 bits.

pub fn as_u32(self) -> u32

Returns the low 32 bits of the hash, at either width.

pub fn try_as_u32(self) -> Option<u32>

Returns the hash as u32 if the width is 4. Returns None if the width is 8.

pub fn try_as_bin_hash(self) -> Option<BinHash>

Returns the hash as a BinHash if the width is 4. Returns None if the width is 8.

pub fn width(self) -> HashWidth

Returns the stored width.

Trait Implementations

impl AsRef<HashValue> for Hash

fn as_ref(&self) -> &HashValue

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Hash

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContainerItem for Hash

impl Debug for Hash

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

Formats the value using the given formatter.

impl Default for Hash

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Hash

type Target = HashValue

The resulting type after dereferencing.

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

Dereferences the value.

impl Eq for Hash

impl From<Hash> for PropertyValueEnum

fn from(other: Hash) -> Self

Converts to this type from the input type.

impl<S: Into<HashValue>> From<S> for Hash

fn from(value: S) -> Self

Converts to this type from the input type.

impl FromValue for Hash

fn from_value(value: &PropertyValueEnum) -> Option<&Self>

The value as Self, if that is its kind.

fn from_value_mut(value: &mut PropertyValueEnum) -> Option<&mut Self>

See FromValue::from_value.

impl Hash for Hash

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 PartialEq for Hash

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

Equality operator ==.

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

Inequality operator !=.

impl PropertyExt for Hash

fn size_no_header(&self) -> usize

fn size(&self, include_header: bool) -> usize

Get the size of the property value, including the kind header if specified

impl PropertyValueExt for Hash

const KIND: Kind = Kind::Hash

impl ReadProperty for Hash

fn from_reader<R: Read + ?Sized>( reader: &mut R, _legacy: bool, ) -> Result<Self, Error>

Reads a Hash value of 4 bytes.

No declared size contains a value that is read on its own. Hash::from_reader_with_width reads a value of a given width.

impl StructuralPartialEq for Hash

impl WriteProperty for Hash

fn to_writer<W: Write + Seek + ?Sized>( &self, writer: &mut W, _legacy: bool, ) -> Result<(), Error>