PastryNode

Struct PastryNode 

Source
pub struct PastryNode { /* private fields */ }
Expand description

An instance of a Pastry node.

Implementations§

Source§

impl PastryNode

Source

pub fn new( config: Config, addr: SocketAddr, pub_addr: SocketAddr, ) -> Result<Self>

Registers a new Pastry node which will be available publicly on http://hostname:port

§Arguments
  • config - The Pastry network configuration.
  • addr - The address of the socket to listen on.
  • pub_addr - The address the node will be exposed on.
§Returns

A Result containing the newly registered node.

Examples found in repository?
examples/store/main.rs (line 16)
13    pub fn new(addr: SocketAddr, pub_addr: SocketAddr) -> Result<Self> {
14        let config = Config::new(16);
15        Ok(KVStoreNode {
16            pastry_node: PastryNode::new(config, addr, pub_addr)?,
17        })
18    }
Source

pub async fn bootstrap_and_serve( self, bootstrap_addr: Option<&str>, ) -> Result<()>

Connects to Pastry network via bootstrap node and serves node server. Consumes node.

§Arguments
  • bootstrap_addr - A bootstrap node address.
§Returns

An empty Result

Examples found in repository?
examples/store/main.rs (line 23)
20    pub async fn serve(&mut self, bootstrap_addr: Option<&str>) -> Result<()> {
21        self.pastry_node
22            .clone()
23            .bootstrap_and_serve(bootstrap_addr)
24            .await
25    }
Source

pub fn get_id(&self) -> u64

Gets the internal Pastry node ID.

Source

pub fn get_public_address(&self) -> String

Gets the public Pastry node address.

Source§

impl PastryNode

Source

pub async fn get_kv(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Retrieves a value associated with the given key stored in the Pastry network.

§Arguments
  • key - A slice of bytes representing the key for which the value is requested.
§Returns

Returns a Result which is:

  • Ok(Some(Vec<u8>)) if the key exists, containing the associated value.
  • Ok(None) if the key does not exist.
  • Err(e) where e encapsulates any error encountered during the operation.
Source

pub async fn set_kv(&self, key: &[u8], value: &[u8]) -> Result<Option<Vec<u8>>>

Sets a value for a given key in the Pastry network.

§Arguments
  • key - A slice of bytes representing the key to which the value is to be associated.
  • value - A slice of bytes representing the value to be set.
§Returns

Returns a Result which is:

  • Ok(Some(Vec<u8>)) if the key existed and the value was replaced, containing the old value.
  • Ok(None) if the key did not exist and a new entry was created.
  • Err(e) where e encapsulates any error encountered during the operation.
Source

pub async fn delete_kv(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Deletes the value associated with the given key in the Pastry network.

§Arguments
  • key - A slice of bytes representing the key whose associated value is to be deleted.
§Returns

Returns a Result which is:

  • Ok(Some(Vec<u8>)) if the key existed and the value was successfully deleted, containing the deleted value.
  • Ok(None) if the key did not exist.
  • Err(e) where e encapsulates any error encountered during the operation.

Trait Implementations§

Source§

impl Clone for PastryNode

Source§

fn clone(&self) -> PastryNode

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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<U> for T
where U: From<T>,

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.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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