Struct lightning_encoding::BigSize

pub struct BigSize(_);

Lightning TLV uses a custom variable-length integer called BigSize. It is similar to Bitcoin’s variable-length integers except that it is serialized in big-endian instead of little-endian.

BigSize specification is given at https://github.com/lightningnetwork/lightning-rfc/blob/master/01-messaging.md#type-length-value-format

Like Bitcoin’s variable-length integer, it exhibits ambiguity in that certain values can be encoded in several different ways, which we must check for at deserialization-time. Thus, if you’re looking for an example of a variable-length integer to use for your own project, move along, this is a rather poor design.

Trait Implementations

impl Add<BigSize> for BigSize

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<BigSize> for BigSize

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AsMut<<BigSize as Wrapper>::Inner> for BigSize

fn as_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Performs the conversion.

impl AsRef<<BigSize as Wrapper>::Inner> for BigSize

fn as_ref(&self) -> &<Self as Wrapper>::Inner

Performs the conversion.

impl BitAnd<BigSize> for BigSize

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr<BigSize> for BigSize

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor<BigSize> for BigSize

type Output = Self

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Borrow<<BigSize as Wrapper>::Inner> for BigSize

fn borrow(&self) -> &<Self as Wrapper>::Inner

Immutably borrows from an owned value.

impl BorrowMut<<BigSize as Wrapper>::Inner> for BigSize

fn borrow_mut(&mut self) -> &mut <Self as Wrapper>::Inner

Mutably borrows from an owned value.

impl Clone for BigSize

fn clone(&self) -> BigSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BigSize

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

Formats the value using the given formatter.

impl Deref for BigSize

type Target = <Self as Wrapper>::Inner

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for BigSize

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

Mutably dereferences the value.

impl Display for BigSize

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

Formats the value using the given formatter.

impl Div<BigSize> for BigSize

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<BigSize> for BigSize

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<BigSize> for u64

fn from(wrapped: BigSize) -> Self

Performs the conversion.

impl From<BigSize> for u8

fn from(big_size: BigSize) -> Self

Performs the conversion.

impl From<BigSize> for u16

fn from(big_size: BigSize) -> Self

Performs the conversion.

impl From<BigSize> for u32

fn from(big_size: BigSize) -> Self

Performs the conversion.

impl From<BigSize> for usize

fn from(big_size: BigSize) -> Self

Performs the conversion.

impl From<u16> for BigSize

fn from(v: u16) -> Self

Performs the conversion.

impl From<u32> for BigSize

fn from(v: u32) -> Self

Performs the conversion.

impl From<u64> for BigSize

fn from(v: u64) -> Self

Performs the conversion.

impl From<u8> for BigSize

fn from(v: u8) -> Self

Performs the conversion.

impl From<usize> for BigSize

fn from(val: usize) -> Self

Performs the conversion.

impl FromStr for BigSize

type Err = <<Self as Wrapper>::Inner as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for BigSize

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, 

Feeds a slice of this type into the given Hasher.

impl LightningDecode for BigSize

fn lightning_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn lightning_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using LightningDecode::lightning_decode function.

impl LightningEncode for BigSize

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn lightning_serialize(&self) -> Result<Vec<u8>, Error>

Serializes data as a byte array using LightningEncode::lightning_encode function.

impl LowerHex for BigSize

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

Formats the value using the given formatter.

impl Mul<BigSize> for BigSize

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<BigSize> for BigSize

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Not for BigSize

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl Octal for BigSize

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

Formats the value using the given formatter.

impl Ord for BigSize

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<BigSize> for BigSize

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<BigSize> for BigSize

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

type Output = Self

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self

Performs the % operation.

impl Shl<BigSize> for BigSize

type Output = Self

The resulting type after applying the << operator.

fn shl(self, rhs: Self) -> Self

Performs the << operation.

impl Shr<BigSize> for BigSize

type Output = Self

The resulting type after applying the >> operator.

fn shr(self, rhs: Self) -> Self

Performs the >> operation.

impl Sub<BigSize> for BigSize

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<BigSize> for BigSize

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl UpperHex for BigSize

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

Formats the value using the given formatter.

impl Wrapper for BigSize

type Inner = u64

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns a mutable reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self where
    Self::Inner: Copy, 

Copies the wrapped type

impl Copy for BigSize

impl Eq for BigSize

impl StructuralEq for BigSize

impl StructuralPartialEq for BigSize