Struct Tryte

pub struct Tryte { /* private fields */ }

A struct representing a balanced ternary number with a fixed length of 6 digits.

The underlying representation of the number is an array of six Digit values. This struct provides conversion methods to and from other formats.

Implementations

impl Tryte

pub const MAX: Self

364 or ++++++

pub const MIN: Self

-364 or ------

pub const ZERO: Self

0 or 000000

pub const fn new(raw: [Digit; 6]) -> Self

Creates a new Tryte instance from a given array of Digits.

Arguments

• raw - An array of exactly 6 Digit values representing the balanced ternary digits.

Returns

A new Tryte instance with the specified balanced ternary digits.

Examples

use balanced_ternary::{Tryte, Digit::{Pos, Zero, Neg}};

let digits = [Pos, Zero, Neg, Zero, Pos, Neg];
let tryte = Tryte::new(digits);
assert_eq!(tryte.to_digit_slice(), &digits);

pub fn to_ternary(&self) -> Ternary

Converts the Tryte into its Ternary representation.

Returns

A Ternary object representing the same balanced ternary number.

pub const fn to_digit_slice(&self) -> &[Digit]

Retrieves a slice containing the digits of the Tryte.

Returns

A slice referencing the six-digit array of the Tryte.

This function allows access to the raw representation of the balanced ternary number as a slice of Digit values.

pub fn from_ternary(v: &Ternary) -> Self

Creates a Tryte from the given Ternary.

Arguments

• v - A reference to a Ternary object.

Panics

This function panics if the Ternary contains more than 6 digits.

pub fn to_i16(&self) -> i16

Converts the Tryte into a signed 16-bit integer.

Returns

A i16 representing the decimal value of the Tryte.

pub fn from_i8(v: i8) -> Self

Creates a Tryte from a signed 8-bit integer.

Arguments

• v - An unsigned 8-bit integer.

Returns

A Tryte representing the equivalent ternary number.

pub fn from_i16(v: i16) -> Self

Creates a Tryte from a signed 16-bit integer.

Arguments

• v - A signed 16-bit integer.

Returns

A Tryte representing the equivalent ternary number.

pub fn digit(&self, index: usize) -> Digit

Retrieves the digit at the specified index in the Tryte.

Arguments

• index - The index of the digit to retrieve (0-based, right-to-left).

Returns

The Digit at the specified index.

Panics

This function panics if the index is greater than 5.

Trait Implementations

impl Add for Tryte

type Output = Tryte

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl BitAnd for Tryte

type Output = Tryte

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for Tryte

type Output = Tryte

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor for Tryte

type Output = Tryte

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl Clone for Tryte

fn clone(&self) -> Tryte

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tryte

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

Formats the value using the given formatter.

impl Display for Tryte

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

Formats the Tryte for display.

The Tryte is displayed in its balanced ternary representation as a 6-character string.

impl Div for Tryte

type Output = Tryte

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl From<&str> for Tryte

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Tryte

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Ternary> for Tryte

fn from(value: Ternary) -> Self

Converts to this type from the input type.

impl From<Tryte> for String

fn from(value: Tryte) -> Self

Converts to this type from the input type.

impl From<Tryte> for Ternary

fn from(value: Tryte) -> Self

Converts to this type from the input type.

impl From<Tryte> for i16

fn from(value: Tryte) -> Self

Converts to this type from the input type.

impl From<i16> for Tryte

fn from(value: i16) -> Self

Converts to this type from the input type.

impl Hash for Tryte

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

type Output = Tryte

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Neg for Tryte

type Output = Tryte

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Not for Tryte

type Output = Tryte

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for Tryte

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

type Output = Tryte

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Copy for Tryte

impl Eq for Tryte

impl StructuralPartialEq for Tryte