Struct Protocol

pub struct Protocol {
    pub name: String,
    pub delete: bool,
    pub permissions: PermissionOptions,
    pub schema: Option<String>,
    pub channel: Option<ChannelProtocol>,
}

Fields

name: String

delete: bool

permissions: PermissionOptions

schema: Option<String>

channel: Option<ChannelProtocol>

Implementations

impl Protocol

pub fn new( name: &str, delete: bool, permissions: PermissionOptions, schema: Option<String>, channel: Option<ChannelProtocol>, ) -> Result<Self, Error>

pub fn system_protocols() -> BTreeMap<Hash, Protocol>

pub fn root() -> Self

pub fn protocol_folder(protocol: &Hash) -> Self

pub fn dms_channel() -> Self

pub fn agent_keys() -> Self

pub fn date_time() -> Self

pub fn usize() -> Self

pub fn channel_item() -> Self

pub fn pointer() -> Self

pub fn trim_perms(&self, perms: PermissionSet) -> PermissionSet

pub fn subset_perms( &self, perms: &PermissionSet, ) -> Result<PermissionSet, Error>

pub fn validate_child_protocol( &self, child_protocol: &Hash, ) -> Result<(), Error>

pub fn validate_child( &self, perm_record: &PermissionedRecord, ) -> Result<(), Error>

pub fn validate( &self, permissioned_record: &PermissionedRecord, ) -> Result<(), Error>

pub fn validate_self(&self) -> Result<(), Error>

pub fn validate_payload(&self, payload: &[u8]) -> Result<(), Error>

Trait Implementations

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Protocol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Protocol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hashable for Protocol

fn hash(&self) -> Hash

fn hash_bytes(&self) -> Vec<u8>

impl Indexable for Protocol

fn primary_key(&self) -> Vec<u8>

const PRIMARY_KEY: &'static str = "primary_key"

const DEFAULT_SORT: &'static str = Self::PRIMARY_KEY

fn secondary_keys(&self) -> BTreeMap<String, Value>

impl JsonSchema for Protocol

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for Protocol

fn cmp(&self, other: &Protocol) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Protocol

fn eq(&self, other: &Protocol) -> 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 PartialOrd for Protocol

fn partial_cmp(&self, other: &Protocol) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Protocol

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Protocol

impl StructuralPartialEq for Protocol