Skip to main content

EndpointRecord

Struct EndpointRecord 

Source
pub struct EndpointRecord {
    pub allowed: Option<bool>,
    pub enabled: Option<bool>,
    pub name: String,
}
Expand description

Service Endpoint ID (SEID) Record with fields and keys to manage endpoints by cid, role, and eid. Serves as aggregation mechanism for authorization and other functions such as UX naming with regards the endpoint.

The namespace is a tree of branches with each leaf at a specific (cid, role, eid). Retrieval by branch returns groups of leaves as appropriate for a cid branch or cid.role branch. Database Keys are (cid, role, eid) where cid is attributable controller identifier (qb64 prefix) that has role(s) such as watcher, witness etc and eid is the identifier of the controller acting in a role i.e. watcher identifier.

Fields§

§allowed: Option<bool>

AuthZ via reply message

  • Some(true) means eid is allowed as controller of endpoint in role
  • Some(false) means eid is disallowed as controller of endpoint in role
  • None means eid is neither allowed or disallowed (no reply msg)
§enabled: Option<bool>

AuthZ via expose message

  • Some(true) means eid is enabled as controller of endpoint in role
  • Some(false) means eid is disabled as controller of endpoint in role
  • None means eid is neither enabled or disabled (no expose msg)
§name: String

Optional user friendly name for eid in role

Implementations§

Source§

impl EndpointRecord

Source

pub fn new() -> Self

Create a new EndpointRecord with default values

Source

pub fn with_values( allowed: Option<bool>, enabled: Option<bool>, name: String, ) -> Self

Create a new EndpointRecord with specified values

Source

pub fn is_allowed(&self) -> Option<bool>

Check if endpoint is allowed (authorized via reply message)

Source

pub fn is_enabled(&self) -> Option<bool>

Check if endpoint is enabled (authorized via expose message)

Source

pub fn set_allowed(&mut self, allowed: bool)

Set allowed status (add/cut model)

Source

pub fn set_enabled(&mut self, enabled: bool)

Set enabled status

Source

pub fn set_name(&mut self, name: String)

Set user friendly name

Source

pub fn to_map(&self) -> HashMap<String, Value>

Convert to HashMap for iteration/serialization compatibility

Trait Implementations§

Source§

impl Clone for EndpointRecord

Source§

fn clone(&self) -> EndpointRecord

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EndpointRecord

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EndpointRecord

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for EndpointRecord

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for EndpointRecord

Source§

impl IntoIterator for EndpointRecord

Source§

type Item = (String, Value)

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<String, Value>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for EndpointRecord

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EndpointRecord

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EndpointRecord

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

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
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> 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.
§

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