Struct StampIndex 

pub struct StampIndex { /* private fields */ }

A stamp index representing the position of a chunk within a batch.

The stamp index consists of two components:

• bucket: The collision bucket determined by the chunk’s address (also called “x”)
• index: The position within that bucket (also called “y”)

Implementation Note

The exact encoding of the stamp index into a single value is implementation-specific and not defined by the Swarm specifications. This implementation encodes the index as a 64-bit value by concatenating the bucket (high 32 bits) and position (low 32 bits) in big-endian format. Other implementations may use different encodings.

Implementations

impl StampIndex

pub const fn new(bucket: u32, index: u32) -> Self

Creates a new stamp index.

pub const fn bucket(&self) -> u32

Returns the collision bucket (x).

pub const fn index(&self) -> u32

Returns the position within the bucket (y).

pub const fn encode(&self) -> u64

Encodes the stamp index as a 64-bit value for use in stamp digest calculation.

Encoding Format

The encoding concatenates bucket (4 bytes BE) and index (4 bytes BE):

| bucket (32 bits) | index (32 bits) |
|   high 32 bits   |   low 32 bits   |

Implementation Note

This encoding is implementation-specific and not defined by the Swarm specifications. The Swarm protocol only specifies that the stamp contains bucket and index values; the exact wire format for the combined index used in signature computation is left to implementations.

pub const fn decode(encoded: u64) -> Self

Decodes a stamp index from a 64-bit encoded value.

See encode for the encoding format.

pub const fn to_be_bytes(&self) -> [u8; 8]

Converts the index to big-endian bytes (8 bytes total).

pub const fn from_be_bytes(bytes: [u8; 8]) -> Self

Creates a stamp index from big-endian bytes.

Trait Implementations

impl<'a> Arbitrary<'a> for StampIndex

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for StampIndex

fn clone(&self) -> StampIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StampIndex

impl Debug for StampIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StampIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StampIndex

impl From<(u32, u32)> for StampIndex

fn from((bucket, index): (u32, u32)) -> Self

Converts to this type from the input type.

impl From<StampIndex> for (u32, u32)

fn from(idx: StampIndex) -> Self

Converts to this type from the input type.

impl Hash for StampIndex

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StampIndex