Struct ipfs_embed::BucketKey

[−]

pub struct BucketKey<T> { /* private fields */ }

Expand description

A Key in the DHT keyspace with preserved preimage.

Keys in the DHT keyspace identify both the participating nodes, as well as the records stored in the DHT.

Keys have an XOR metric as defined in the Kademlia paper, i.e. the bitwise XOR of the hash digests, interpreted as an integer. See Key::distance.

Implementations

impl<T> Key<T>

pub fn new(preimage: T) -> Key<T> where
T: Borrow<[u8 ]>,

Constructs a new Key by running the given value through a random oracle.

The preimage of type T is preserved. See Key::preimage and Key::into_preimage.

pub fn preimage(&self) -> &T

Borrows the preimage of the key.

pub fn into_preimage(self) -> T

Converts the key into its preimage.

pub fn distance(&self, other: &U) -> Distance where
U: AsRef<KeyBytes>,

Computes the distance of the keys according to the XOR metric.

pub fn for_distance(&self, d: Distance) -> KeyBytes

Returns the uniquely determined key with the given distance to self.

This implements the following equivalence:

self xor other = distance <==> other = self xor distance

Trait Implementations

impl<T> AsRef<KeyBytes> for Key<T>

fn as_ref(&self) -> &KeyBytes

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

impl<T> Clone for Key<T> where
T: Clone,

fn clone(&self) -> Key<T>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<T> Debug for Key<T> where
T: Debug,

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

Formats the value using the given formatter. Read more

impl From<Key> for Key<Key>

fn from(k: Key) -> Key<Key>

Converts to this type from the input type.

impl From<Multihash<64_usize>> for Key<Multihash<64_usize>>

fn from(m: Multihash<64_usize>) -> Key<Multihash<64_usize>>

Converts to this type from the input type.

impl From<PeerId> for Key<PeerId>

fn from(p: PeerId) -> Key<PeerId>

Converts to this type from the input type.

impl From<Vec<u8, Global>> for Key<Vec<u8, Global>>

fn from(b: Vec<u8, Global>) -> Key<Vec<u8, Global>>

Converts to this type from the input type.

impl<T> Hash for Key<T>

fn hash<H>(&self, state: &mut H) where
H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl<T> Into<KeyBytes> for Key<T>

fn into(self) -> KeyBytes

Converts this type into the (usually inferred) input type.

impl<T, U> PartialEq<Key> for Key<T>

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

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

1.0.0 · source

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

This method tests for !=.

impl<T> Eq for Key<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Key<T> where
T: RefUnwindSafe,

impl<T> Send for Key<T> where
T: Send,

impl<T> Sync for Key<T> where
T: Sync,

impl<T> Unpin for Key<T> where
T: Unpin,

impl<T> UnwindSafe for Key<T> where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> References<RawCodec> for T

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error> where
R: Read,
E: Extend<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>,

Scrape the references from an impl Read. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ipfs_embed::BucketKey

Implementations

impl<T> Key<T>

pub fn new(preimage: T) -> Key<T> where T: Borrow<[u8]>,

pub fn preimage(&self) -> &T

pub fn into_preimage(self) -> T

pub fn distance<U>(&self, other: &U) -> Distance where U: AsRef<KeyBytes>,

pub fn for_distance(&self, d: Distance) -> KeyBytes

Trait Implementations

impl<T> AsRef<KeyBytes> for Key<T>

fn as_ref(&self) -> &KeyBytes

impl<T> Clone for Key<T> where T: Clone,

fn clone(&self) -> Key<T>

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

impl<T> Debug for Key<T> where T: Debug,

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

impl From<Key> for Key<Key>

fn from(k: Key) -> Key<Key>

impl From<Multihash<64_usize>> for Key<Multihash<64_usize>>

fn from(m: Multihash<64_usize>) -> Key<Multihash<64_usize>>

impl From<PeerId> for Key<PeerId>

fn from(p: PeerId) -> Key<PeerId>

impl From<Vec<u8, Global>> for Key<Vec<u8, Global>>

fn from(b: Vec<u8, Global>) -> Key<Vec<u8, Global>>

impl<T> Hash for Key<T>

fn hash<H>(&self, state: &mut H) where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl<T> Into<KeyBytes> for Key<T>

fn into(self) -> KeyBytes

impl<T, U> PartialEq<Key<U>> for Key<T>

fn eq(&self, other: &Key<U>) -> bool

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

impl<T> Eq for Key<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Key<T> where T: RefUnwindSafe,

impl<T> Send for Key<T> where T: Send,

impl<T> Sync for Key<T> where T: Sync,

impl<T> Unpin for Key<T> where T: Unpin,

impl<T> UnwindSafe for Key<T> where T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CallHasher for T where T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> References<RawCodec> for T

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error> where R: Read, E: Extend<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>,

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> Erased for T

pub fn new(preimage: T) -> Key<T> where
T: Borrow<[u8 ]>,

pub fn distance<U>(&self, other: &U) -> Distance where
U: AsRef<KeyBytes>,

impl<T> Clone for Key<T> where
T: Clone,

impl<T> Debug for Key<T> where
T: Debug,

fn hash<H>(&self, state: &mut H) where
H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

impl<T> RefUnwindSafe for Key<T> where
T: RefUnwindSafe,

impl<T> Send for Key<T> where
T: Send,

impl<T> Sync for Key<T> where
T: Sync,

impl<T> Unpin for Key<T> where
T: Unpin,

impl<T> UnwindSafe for Key<T> where
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T, U> Into<U> for T where
U: From<T>,

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error> where
R: Read,
E: Extend<Cid<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,