Struct Word6 

pub struct Word6(/* private fields */);

A balanced ternary word consisting of 6 trits.

Value Range

A Word6 can represent values from -364 to +364:

Value = t0*1 + t1*3 + t2*9 + t3*27 + t4*81 + t5*243
Min: -1 - 3 - 9 - 27 - 81 - 243 = -364
Max: +1 + 3 + 9 + 27 + 81 + 243 = +364

Internal Representation

Stored as a u16 with 2 bits per trit:

• Bits 0-1: trit 0 (least significant)
• Bits 2-3: trit 1
• …
• Bits 10-11: trit 5 (most significant)

Examples

use trit_vsa::Word6;

let w = Word6::from_value(100).unwrap();
assert_eq!(w.value(), 100);

let w_neg = -w;
assert_eq!(w_neg.value(), -100);

Implementations

impl Word6

pub fn from_value(value: i32) -> Result<Word6, TernaryError>

Create a word from an integer value.

Arguments

• value - Integer value (-364 to +364)

Errors

Returns TernaryError::InvalidWordValue if value is outside range.

Examples

use trit_vsa::Word6;

let w = Word6::from_value(123).unwrap();
assert_eq!(w.value(), 123);

assert!(Word6::from_value(365).is_err());
assert!(Word6::from_value(-365).is_err());

pub fn from_trits(trits: [Trit; 6]) -> Word6

Create a word from six trits.

Arguments

• trits - Array of 6 trits [t0, t1, t2, t3, t4, t5] where t0 is least significant

pub fn from_trytes(low: Tryte3, high: Tryte3) -> Word6

Create a word from two trytes.

Arguments

• low - Low tryte (trits 0-2)
• high - High tryte (trits 3-5)

pub fn value(self) -> i32

Get the integer value of the word.

pub fn to_trits(self) -> [Trit; 6]

Extract the six trits.

Returns

Array [t0, …, t5] where t0 is least significant.

pub fn to_trytes(self) -> (Tryte3, Tryte3)

Split into two trytes.

Returns

Tuple (low, high) where low contains trits 0-2 and high contains trits 3-5.

pub fn get_trit(self, index: usize) -> Trit

Get a specific trit by index.

Arguments

• index - Trit index (0-5)

Panics

Panics if index >= 6.

pub const fn zero() -> Word6

Create a zero word.

pub fn is_zero(self) -> bool

Check if the word is zero.

pub const fn raw(self) -> u16

Get the raw packed representation.

Trait Implementations

impl Add for Word6

fn add(self, other: Word6) -> <Word6 as Add>::Output

Add two words, returning (result, carry).

type Output = (Word6, Trit)

The resulting type after applying the + operator.

impl Clone for Word6

fn clone(&self) -> Word6

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Word6

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

Formats the value using the given formatter.

impl Default for Word6

fn default() -> Word6

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Word6

fn deserialize<__D>( __deserializer: __D, ) -> Result<Word6, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Word6

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

Formats the value using the given formatter.

impl Hash for Word6

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 Mul for Word6

fn mul(self, other: Word6) -> <Word6 as Mul>::Output

Multiply two words, returning (low, high) result.

The full result is low + high * 729.

type Output = (Word6, Word6)

The resulting type after applying the * operator.

impl Neg for Word6

type Output = Word6

The resulting type after applying the - operator.

fn neg(self) -> <Word6 as Neg>::Output

Performs the unary - operation.

impl PartialEq for Word6

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<i32> for Word6

type Error = TernaryError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Word6, TernaryError>

Performs the conversion.

impl Copy for Word6

impl Eq for Word6

impl StructuralPartialEq for Word6