Struct dsf_core::service::Service

pub struct Service { /* fields omitted */ }

Generic Service Type. This provides the basis for all services in DSR.

Services should be constructed using the ServiceBuilder type

Implementations

impl Service

pub fn id(&self) -> Id

pub fn update<U>(&mut self, update_fn: U) -> Result<(), Error> where
    U: Fn(&mut Body, &mut Vec<Options>, &mut PrivateOptions), 

Update a service. This allows in-place editing of descriptors and options and causes an update of the service version number as well as a reset of the data_index.

pub fn is_origin(&self) -> bool

pub fn public_key(&self) -> PublicKey

pub fn private_key(&self) -> Option<PrivateKey>

pub fn secret_key(&self) -> Option<SecretKey>

pub fn set_private_key(&mut self, key: Option<PrivateKey>)

pub fn set_secret_key(&mut self, key: Option<SecretKey>)

Trait Implementations

impl Clone for Service

fn clone(&self) -> Service

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Service

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

Formats the value using the given formatter.

impl Default for Service

fn default() -> Service

Create a default / blank Service for further initialisation.

impl Net for Service

fn build_request(&self, req: &Request) -> Base

Generate a protocol request object from a request message

fn build_response(&self, req: &Request, _from: Address, resp: &Response) -> Base

Generate a protocol response object from a response message (and it's associated request)

fn encode_message<T: AsRef<[u8]> + AsMut<[u8]>>(
    &self,
    msg: Message,
    buff: T
) -> Result<usize, Error>

Encode a message

impl PartialEq<Service> for Service

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

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

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

This method tests for !=.

impl Publisher for Service

fn publish_primary<T: AsRef<[u8]> + AsMut<[u8]>>(
    &mut self,
    buff: T
) -> Result<(usize, Page), Error>

Publish generates a page to publishing for the given service.

fn publish_secondary<T: AsRef<[u8]> + AsMut<[u8]>>(
    &mut self,
    options: SecondaryOptions,
    buff: T
) -> Result<(usize, Page), Error>

Secondary generates a secondary page using this service to be attached to the provided service ID

fn publish_data<T: AsRef<[u8]> + AsMut<[u8]>>(
    &mut self,
    options: DataOptions,
    buff: T
) -> Result<(usize, Page), Error>

Create a data object for publishing with the provided options and encodes it into the provided buffer

impl StructuralPartialEq for Service

impl Subscriber for Service

fn load(page: &Page) -> Result<Service, Error>

Create a service instance from a given page

fn apply_primary(&mut self, update: &Page) -> Result<bool, Error>

Apply an upgrade to an existing service. This consumes a new page and updates the service instance

fn validate_page(&mut self, page: &Page) -> Result<(), Error>

Validate a given secondary page published by this service