Struct DynToken 

pub struct DynToken { /* private fields */ }

A signed magnitude integer used as both a hash output and a ring coordinate.

Examples

use dynomite::hashkit::DynToken;
let mut t = DynToken::from_u32(7);
assert_eq!(t.get_int(), 7);
assert_eq!(t.len(), 1);

Implementations

impl DynToken

pub fn new() -> Self

Construct an empty token (sign zero, no magnitude words).

Examples

use dynomite::hashkit::DynToken;
let t = DynToken::new();
assert!(t.is_empty());

pub fn from_u32(value: u32) -> Self

Construct a token holding a single 32-bit value.

Examples

use dynomite::hashkit::DynToken;
let t = DynToken::from_u32(7);
assert_eq!(t.get_int(), 7);

pub fn size(&mut self, len: usize) -> Result<(), DynError>

Set the number of magnitude words. Returns an error if len exceeds TOKEN_WORD_CAPACITY.

Examples

use dynomite::hashkit::DynToken;
let mut t = DynToken::default();
assert!(t.size(2).is_ok());
assert!(t.size(99).is_err());

pub fn len(&self) -> usize

Number of magnitude words currently in use.

Examples

use dynomite::hashkit::DynToken;
assert_eq!(DynToken::from_u32(1).len(), 1);
assert_eq!(DynToken::default().len(), 0);

pub fn is_empty(&self) -> bool

Whether the token holds no magnitude words.

Examples

use dynomite::hashkit::DynToken;
assert!(DynToken::default().is_empty());
assert!(!DynToken::from_u32(1).is_empty());

pub fn sign(&self) -> Sign

Sign field.

Examples

use dynomite::hashkit::DynToken;
use dynomite::hashkit::token::Sign;
assert_eq!(DynToken::from_u32(1).sign(), Sign::Positive);
assert_eq!(DynToken::default().sign(), Sign::Zero);

pub fn mag(&self) -> &[u32]

Read-only view of the magnitude words actually in use.

Examples

use dynomite::hashkit::DynToken;
let t = DynToken::from_u32(0xdead);
assert_eq!(t.mag(), &[0xdead]);

pub fn mag_mut(&mut self) -> &mut [u32; 4]

Mutable access to the full magnitude buffer (capacity-sized).

Examples

use dynomite::hashkit::DynToken;
use dynomite::hashkit::token::TOKEN_WORD_CAPACITY;
let mut t = DynToken::default();
t.size(2).unwrap();
t.mag_mut()[0] = 1;
assert_eq!(t.mag_mut().len(), TOKEN_WORD_CAPACITY);

pub fn set_len_keep(&mut self, len: usize)

Force the length without resetting the sign or zeroing words.

Examples

use dynomite::hashkit::DynToken;
let mut t = DynToken::default();
t.mag_mut()[0] = 0xaa;
t.set_len_keep(1);
assert_eq!(t.len(), 1);
assert_eq!(t.get_int(), 0xaa);

pub fn set_sign(&mut self, sign: Sign)

Sets sign explicitly. Mostly useful in tests.

Examples

use dynomite::hashkit::DynToken;
use dynomite::hashkit::token::Sign;
let mut t = DynToken::from_u32(1);
t.set_sign(Sign::Negative);
assert_eq!(t.sign(), Sign::Negative);

pub fn set_int(&mut self, val: u32)

Set the token to a single 32-bit value.

Sign becomes Positive when val > 0, Zero otherwise. Length is forced to 1.

Examples

use dynomite::hashkit::DynToken;
let mut t = DynToken::default();
t.size(1).unwrap();
t.set_int(99);
assert_eq!(t.get_int(), 99);

pub fn get_int(&self) -> u32

Read the token’s first word as a 32-bit unsigned value.

Examples

use dynomite::hashkit::DynToken;
assert_eq!(DynToken::from_u32(33).get_int(), 33);
assert_eq!(DynToken::default().get_int(), 0);

pub fn to_hex(&self) -> String

Hex dump of the magnitude words, big-endian per word, in declaration order. Used by tests and the dyn-hash-tool CLI.

Examples

use dynomite::hashkit::DynToken;
assert_eq!(DynToken::from_u32(0xdead).to_hex(), "0000dead");

Trait Implementations

impl Clone for DynToken

fn clone(&self) -> DynToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynToken

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

Formats the value using the given formatter.

impl Default for DynToken

fn default() -> Self

Returns the “default value” for a type.

impl Display for DynToken

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

Formats the value using the given formatter.

impl Hash for DynToken

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 DynToken

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

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

fn partial_cmp(&self, other: &Self) -> 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 Eq for DynToken