Struct SwarmAddress 

pub struct SwarmAddress(pub B256);

A 256-bit address for a chunk in the Swarm network

Tuple Fields

0: B256

Implementations

impl SwarmAddress

pub const fn with_first_byte(byte: u8) -> Self

Creates an address with only the first byte set, rest zeros.

The first byte controls proximity order (leading bits determine PO).

pub fn new(bytes: [u8; 32]) -> Self

Creates a new SwarmAddress from raw bytes

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

Returns the underlying bytes

pub fn from_slice(slice: &[u8]) -> Result<Self>

Creates a new address from a slice, checking the length

pub fn is_zero(&self) -> bool

Checks if this address is zeros

pub const fn zero() -> Self

Create a new zero-filled address

pub fn distance(&self, y: &Self) -> U256

Calculate the distance between Self and address y in big-endian

pub fn distance_cmp(&self, x: &Self, y: &Self) -> Ordering

Compares addresses x and y by their distance from self.

Returns:

• Ordering::Less if x is farther from self than y (i.e., y is closer)
• Ordering::Greater if x is closer to self than y
• Ordering::Equal if x and y are equidistant from self

Usage with min_by

This comparator is designed for use with Iterator::min_by to find the address closest to self:

let target = SwarmAddress::zero();
let addresses = vec![
    SwarmAddress::from(B256::repeat_byte(0x01)),
    SwarmAddress::from(B256::repeat_byte(0x02)),
];
let closest = addresses.iter().min_by(|a, b| target.distance_cmp(a, b));

Note: The ordering may seem inverted from intuition. Greater means x is closer (smaller distance), because min_by selects the element for which the comparator returns Less - and we want to select the one that is NOT closer (i.e., has a larger distance), leaving the closest.

pub fn closer(&self, x: &Self, y: &Self) -> bool

Determine if self is closer to x than to y.

Returns true if distance(self, x) < distance(self, y).

pub fn is_within_proximity( &self, other: &Self, min_proximity: ProximityOrder, ) -> bool

Check if this address is within the given proximity to another address

pub fn proximity(&self, other: &Self) -> ProximityOrder

Calculate the proximity order between self and another address.

Returns the number of leading bits that match between the two addresses, capped at MAX_PO (31). Use this for standard Kademlia routing operations.

For operations requiring finer granularity (like reserve sampling), use extended_proximity() instead.

pub fn extended_proximity(&self, other: &Self) -> u8

Calculate the extended proximity order between self and another address.

Returns the number of leading bits that match between the two addresses, capped at EXTENDED_PO (36). Use this for Kademlia bin balancing where the algorithm checks po + BitSuffixLength + 1 (up to 36 for bin 31).

Returns a raw u8 because the extended range exceeds ProximityOrder’s invariant (0..=MAX_PO). For standard routing, use proximity() instead.

pub fn xor(&self, other: &Self) -> Self

XOR distance - bitwise XOR of the two 32-byte addresses as a new SwarmAddress. Useful when callers want the raw distance bytes (e.g. for content-routing bias) rather than the proximity-order metric.

pub fn bin(&self, anchor: &Self) -> Bin

Kademlia bin index of self relative to anchor - semantic alias for Bin::from(self.proximity(anchor)). The routing-table convention is “the bin a peer occupies is its proximity order to our own overlay”.

Methods from Deref<Target = B256>

pub const ZERO: FixedBytes<N>

pub fn as_slice(&self) -> &[u8]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn covers(&self, other: &FixedBytes<N>) -> bool

Returns true if all bits set in self are also set in b.

pub fn const_eq(&self, other: &FixedBytes<N>) -> bool

Compile-time equality. NOT constant-time equality.

pub fn is_zero(&self) -> bool

Returns true if no bits are set.

pub fn const_is_zero(&self) -> bool

Returns true if no bits are set.

Methods from Deref<Target = [u8; N]>

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into an array of ASCII characters, or returns None if any of the characters is non-ASCII.

Examples

#![feature(ascii_char)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into an array of ASCII characters, without checking whether they’re valid.

Safety

Every byte in the array must be in 0..=127, or else this is UB.

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

Trait Implementations

impl<'a> Arbitrary<'a> for SwarmAddress

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 AsRef<[u8]> for SwarmAddress

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SwarmAddress

fn clone(&self) -> SwarmAddress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SwarmAddress

impl Debug for SwarmAddress

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

Formats the value using the given formatter.

impl Default for SwarmAddress

fn default() -> Self

Returns the “default value” for a type.

impl Deref for SwarmAddress

type Target = FixedBytes<32>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for SwarmAddress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SwarmAddress

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

Formats the value using the given formatter.

impl Eq for SwarmAddress

impl From<FixedBytes<32>> for SwarmAddress

fn from(value: B256) -> Self

Converts to this type from the input type.

impl From<SwarmAddress> for B256

fn from(addr: SwarmAddress) -> Self

Converts to this type from the input type.

impl From<SwarmAddress> for [u8; 32]

fn from(addr: SwarmAddress) -> Self

Converts to this type from the input type.

impl From<SwarmAddress> for EntryRef

fn from(addr: ChunkAddress) -> Self

Converts to this type from the input type.

impl From<[u8; 32]> for SwarmAddress

fn from(bytes: [u8; 32]) -> Self

Converts to this type from the input type.

impl Hash for SwarmAddress

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 Ord for SwarmAddress

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SwarmAddress

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SwarmAddress

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 SwarmAddress