KademliaCommand

litep2p::protocol::libp2p::kademlia

Enum KademliaCommand

pub enum KademliaCommand {
    AddKnownPeer {
        peer: PeerId,
        addresses: Vec<Multiaddr>,
    },
    FindNode {
        peer: PeerId,
        query_id: QueryId,
    },
    PutRecord {
        record: Record,
        quorum: Quorum,
        query_id: QueryId,
    },
    PutRecordToPeers {
        record: Record,
        quorum: Quorum,
        query_id: QueryId,
        peers: Vec<PeerId>,
        update_local_store: bool,
    },
    GetRecord {
        key: RecordKey,
        quorum: Quorum,
        query_id: QueryId,
    },
    GetProviders {
        key: RecordKey,
        query_id: QueryId,
    },
    StartProviding {
        key: RecordKey,
        quorum: Quorum,
        query_id: QueryId,
    },
    StopProviding {
        key: RecordKey,
    },
    StoreRecord {
        record: Record,
    },
}

Expand description

Kademlia commands.

Variants§

AddKnownPeer

Add known peer.

Fields

§peer: PeerId

Peer ID.

§addresses: Vec<Multiaddr>

Addresses of peer.

FindNode

Send FIND_NODE message.

Fields

§peer: PeerId

Peer ID.

§query_id: QueryId

Query ID for the query.

PutRecord

Store record to DHT.

Fields

§record: Record

Record.

§quorum: Quorum

Quorum for the query.

§query_id: QueryId

Query ID for the query.

PutRecordToPeers

Store record to DHT to the given peers.

Similar to KademliaCommand::PutRecord but allows user to specify the peers.

Fields

§record: Record

Record.

§quorum: Quorum

Quorum for the query.

§query_id: QueryId

Query ID for the query.

§peers: Vec<PeerId>

Use the following peers for the put request.

§update_local_store: bool

Update local store.

GetRecord

Get record from DHT.

Fields

§key: RecordKey

Record key.

§quorum: Quorum

Quorum for the query.

§query_id: QueryId

Query ID for the query.

GetProviders

Get providers from DHT.

Fields

§key: RecordKey

Provided key.

§query_id: QueryId

Query ID for the query.

StartProviding

Register as a content provider for key.

Fields

§key: RecordKey

Provided key.

§quorum: Quorum

Quorum for the query.

§query_id: QueryId

Query ID for the query.

StopProviding

Stop providing the key locally and refreshing the provider.

Fields

§key: RecordKey

Provided key.

StoreRecord

Store record locally.

Fields

§record: Record

Trait Implementations§

impl Debug for KademliaCommand

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !Freeze for KademliaCommand

impl RefUnwindSafe for KademliaCommand

impl Send for KademliaCommand

impl Sync for KademliaCommand

impl Unpin for KademliaCommand

impl UnwindSafe for KademliaCommand

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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