Enum ServerRole 

pub enum ServerRole {
    Regular,
    LogServer,
    Anchor,
}

ServerRole describes the functional role of an NWEP server node.

The role affects how the C library routes incoming requests internally: certain path prefixes are intercepted and handled by built-in subsystems rather than dispatched to application-level handlers. A server built with the Rust bindings must choose a role at construction time via ServerBuilder::role.

The Default implementation returns ServerRole::Regular, which is the appropriate choice for application-level servers.

Variants

Regular

Regular identifies a standard application server.

All incoming requests are dispatched to the application’s registered handlers. No paths are intercepted by the library. This is the default role and should be used for all nodes that do not serve trust-log or anchor functions.

LogServer

LogServer identifies a node that hosts the distributed Merkle identity log.

In addition to application handlers, a LogServer intercepts all requests whose path begins with /log/ and routes them to the C library’s built-in log management subsystem. These paths handle log entry submission, Merkle proof retrieval, and checkpoint synchronization.

Only designate a node as LogServer if it has been provisioned with persistent log storage and configured as a trust authority in the network’s root anchoring document.

Anchor

Anchor identifies a BLS threshold signing authority node.

An Anchor intercepts all requests whose path begins with /checkpoint/ and routes them to the C library’s built-in BLS checkpoint subsystem. Anchor nodes hold a BLS private key share and participate in threshold signing rounds to produce periodic checkpoints over the Merkle log root.

The network requires at least crate::types::DEFAULT_ANCHOR_THRESHOLD functioning anchor nodes to ratify a checkpoint. Anchor nodes are registered in the trust root and their BLS public keys are well-known.

Implementations

impl ServerRole

pub fn from_str(s: &str) -> Self

from_str parses a role string (as advertised in the roles header) and returns the corresponding ServerRole variant.

The parsing is delegated to the C library. Unrecognized strings map to ServerRole::Regular, which is the safe default.

Example

use nwep::role::ServerRole;

assert_eq!(ServerRole::from_str("regular"),    ServerRole::Regular);
assert_eq!(ServerRole::from_str("log_server"), ServerRole::LogServer);
assert_eq!(ServerRole::from_str("anchor"),     ServerRole::Anchor);
assert_eq!(ServerRole::from_str("unknown"),    ServerRole::Regular);

pub fn as_str(&self) -> &'static str

as_str returns the canonical lowercase wire-format string for this role.

The string is retrieved from the C library’s string table and is valid for the lifetime of the process. It is the same value that appears in the roles header of a connect response.

Example

use nwep::role::ServerRole;

assert_eq!(ServerRole::Regular.as_str(),   "regular");
assert_eq!(ServerRole::LogServer.as_str(), "log_server");
assert_eq!(ServerRole::Anchor.as_str(),    "anchor");

Trait Implementations

impl Clone for ServerRole

fn clone(&self) -> ServerRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerRole

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

Formats the value using the given formatter.

impl Default for ServerRole

fn default() -> ServerRole

Returns the “default value” for a type.

impl Display for ServerRole

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

Formats the value using the given formatter.

impl From<u32> for ServerRole

fn from(r: c_uint) -> Self

Converts to this type from the input type.

impl Hash for ServerRole

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ServerRole

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ServerRole

impl Eq for ServerRole

impl StructuralPartialEq for ServerRole