Struct bitcoin::util::bip152::ShortId

pub struct ShortId(_);

Short transaction IDs are used to represent a transaction without sending a full 256-bit hash.

Implementations

impl ShortId

pub fn as_ptr(&self) -> *const u8

Converts the object to a raw pointer

pub fn as_mut_ptr(&mut self) -> *mut u8

Converts the object to a mutable raw pointer

pub fn len(&self) -> usize

Returns the length of the object as an array

pub fn is_empty(&self) -> bool

Returns whether the object, as an array, is empty. Always false.

pub fn as_bytes(&self) -> &[u8; 6]

Returns the underlying bytes.

pub fn to_bytes(self) -> [u8; 6]

Returns the underlying bytes.

pub fn into_bytes(self) -> [u8; 6]

Returns the underlying bytes.

impl ShortId

pub fn calculate_siphash_keys(header: &BlockHeader, nonce: u64) -> (u64, u64)

Calculate the SipHash24 keys used to calculate short IDs.

pub fn with_siphash_keys<T: AsRef<[u8]>>(
    txid: &T,
    siphash_keys: (u64, u64)
) -> ShortId

Calculate the short ID with the given (w)txid and using the provided SipHash keys.

Trait Implementations

impl Clone for ShortId

fn clone(&self) -> ShortId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShortId

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

Formats the value using the given formatter.

impl Decodable for ShortId

fn consensus_decode<D: Read + ?Sized>(d: &mut D) -> Result<ShortId, Error>

Decode an object with a well-defined format.

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

Decode Self from a size-limited reader.

impl Default for ShortId

fn default() -> ShortId

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShortId

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<ShortId, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ShortId

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

Formats the value using the given formatter.

impl Encodable for ShortId

fn consensus_encode<S: Write + ?Sized>(&self, s: &mut S) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

impl<'a> From<&'a [u8]> for ShortId

fn from(data: &'a [u8]) -> ShortId

Converts to this type from the input type.

impl FromHex for ShortId

fn from_byte_iter<I>(iter: I) -> Result<Self, Error>where
    I: Iterator<Item = Result<u8, Error>> + ExactSizeIterator + DoubleEndedIterator,

Produces an object from a byte iterator.

fn from_hex(s: &str) -> Result<Self, Error>

Produces an object from a hex string.

impl FromStr for ShortId

type Err = Error

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 ShortId

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<I> Index<I> for ShortIdwhere
    [u8]: Index<I>,

type Output = <[u8] as Index<I>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl LowerHex for ShortId

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

Formats the value using the given formatter.

impl Ord for ShortId

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

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ShortId> for ShortId

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ShortId> for ShortId

fn partial_cmp(&self, other: &ShortId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

const 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 Serialize for ShortId

Available on crate feature serde only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Copy for ShortId

impl Eq for ShortId

impl StructuralEq for ShortId

impl StructuralPartialEq for ShortId