Struct kad::dht::Dht

pub struct Dht<Id, Info, Data, ReqId, Conn, Table, Store, Ctx> { /* fields omitted */ }

Methods

impl<Id, Info, Data, ReqId, Conn, Table, Store, Ctx> Dht<Id, Info, Data, ReqId, Conn, Table, Store, Ctx> where
    Id: DatabaseId + Clone + Send + 'static,
    Info: PartialEq + Clone + Debug + Send + 'static,
    Data: PartialEq + Clone + Send + Debug + 'static,
    ReqId: RequestId + Clone + Send + 'static,
    Conn: Connector<ReqId, Entry<Id, Info>, Request<Id, Data>, Response<Id, Info, Data>, Error, Ctx> + Clone + Send + 'static,
    Table: NodeTable<Id, Info> + Clone + Sync + Send + 'static,
    Store: Datastore<Id, Data> + Clone + Sync + Send + 'static,
    Ctx: Clone + Debug + PartialEq + Send + 'static, 

pub fn new(
    id: Id,
    config: Config,
    table: Table,
    conn_mgr: Conn,
    datastore: Store
) -> Dht<Id, Info, Data, ReqId, Conn, Table, Store, Ctx>

pub fn connect(
    &mut self,
    target: Entry<Id, Info>,
    ctx: Ctx
) -> impl Future<Item = (), Error = Error>

Connect to a known node This is used for bootstrapping onto the DHT

pub fn lookup(
    &mut self,
    target: Id,
    ctx: Ctx
) -> impl Future<Item = Entry<Id, Info>, Error = Error>

Look up a node in the database by Id

pub fn find(
    &mut self,
    target: Id,
    ctx: Ctx
) -> impl Future<Item = Vec<Data>, Error = Error>

Find a value from the DHT

pub fn store(
    &mut self,
    target: Id,
    data: Vec<Data>,
    ctx: Ctx
) -> impl Future<Item = (), Error = Error>

Store a value in the DHT

pub fn refresh(&mut self) -> impl Future<Item = (), Error = Error>

Refresh node table

pub fn receive(
    &mut self,
    from: &Entry<Id, Info>,
    req: &Request<Id, Data>
) -> impl Future<Item = Response<Id, Info, Data>, Error = Error>

Receive and reply to requests

pub fn search(
    &mut self,
    id: Id,
    op: Operation,
    seed: &[Entry<Id, Info>],
    ctx: Ctx
) -> impl Future<Item = Search<Id, Info, Data, Table, Conn, ReqId, Ctx>, Error = Error>

Create a basic search using the DHT This is provided for integration of the Dht with other components

Trait Implementations

impl<Id: Clone, Info: Clone, Data: Clone, ReqId: Clone, Conn: Clone, Table: Clone, Store: Clone, Ctx: Clone> Clone for Dht<Id, Info, Data, ReqId, Conn, Table, Store, Ctx>

fn clone(&self) -> Dht<Id, Info, Data, ReqId, Conn, Table, Store, Ctx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Id, Info, Data, ReqId, Conn, Table, Store, Ctx> Future for Dht<Id, Info, Data, ReqId, Conn, Table, Store, Ctx>

Stream trait implemented to allow polling on dht object

type Item = ()

The type of value that this future will resolved with if it is successful.

type Error = ()

The type of error that this future will resolve with if it fails in a normal fashion.

fn poll(&mut self) -> Poll<Self::Item, Self::Error>

Query this future to see if its value has become available, registering interest if it is not.

default fn wait(self) -> Result<Self::Item, Self::Error>

Block the current thread until this future is resolved.

default fn map<F, U>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Item) -> U, 

Map this future's result to a different type, returning a new future of the resulting type.

default fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Map this future's error to a different error, returning a new future.

default fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this future's error to any error implementing From for this future's Error, returning a new future.

default fn then<F, B>(self, f: F) -> Then<Self, B, F> where
    B: IntoFuture,
    F: FnOnce(Result<Self::Item, Self::Error>) -> B, 

Chain on a computation for when a future finished, passing the result of the future to the provided closure f.

default fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where
    B: IntoFuture<Error = Self::Error>,
    F: FnOnce(Self::Item) -> B, 

Execute another future after this one has resolved successfully.

default fn or_else<F, B>(self, f: F) -> OrElse<Self, B, F> where
    B: IntoFuture<Item = Self::Item>,
    F: FnOnce(Self::Error) -> B, 

Execute another future if this one resolves with an error.

default fn select<B>(self, other: B) -> Select<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Item = Self::Item, Error = Self::Error>, 

Waits for either one of two futures to complete.

default fn select2<B>(
    self,
    other: B
) -> Select2<Self, <B as IntoFuture>::Future> where
    B: IntoFuture, 

Waits for either one of two differently-typed futures to complete.

default fn join<B>(self, other: B) -> Join<Self, <B as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>, 

Joins the result of two futures, waiting for them both to complete.

default fn join3<B, C>(
    self,
    b: B,
    c: C
) -> Join3<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

default fn join4<B, C, D>(
    self,
    b: B,
    c: C,
    d: D
) -> Join4<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

default fn join5<B, C, D, E>(
    self,
    b: B,
    c: C,
    d: D,
    e: E
) -> Join5<Self, <B as IntoFuture>::Future, <C as IntoFuture>::Future, <D as IntoFuture>::Future, <E as IntoFuture>::Future> where
    B: IntoFuture<Error = Self::Error>,
    C: IntoFuture<Error = Self::Error>,
    D: IntoFuture<Error = Self::Error>,
    E: IntoFuture<Error = Self::Error>, 

Same as join, but with more futures.

default fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream.

default fn flatten(self) -> Flatten<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error: From<Self::Error>, 

Flatten the execution of this future when the successful result of this future is itself another future.

default fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error == Self::Error, 

Flatten the execution of this future when the successful result of this future is a stream.

default fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed.

default fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Item), 

Do something with the item of a future, passing it on.

default fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the future.

default fn shared(self) -> Shared<Self>

Create a cloneable handle to this future where all handles will resolve to the same result.