Struct MessagePolicy

pub struct MessagePolicy {
    pub blanket: BlanketMessagePolicy,
    pub restrict_chain_ids_to: Option<HashSet<ChainId>>,
    pub ignore_chain_ids: HashSet<ChainId>,
    pub reject_message_bundles_without_application_ids: Option<HashSet<GenericApplicationId>>,
    pub reject_message_bundles_with_other_application_ids: Option<HashSet<GenericApplicationId>>,
    pub process_events_from_application_ids: Option<HashSet<GenericApplicationId>>,
    pub never_reject_application_ids: HashSet<GenericApplicationId>,
}

Policies for automatically handling incoming messages.

Fields

blanket: BlanketMessagePolicy

The blanket policy applied to all messages.

restrict_chain_ids_to: Option<HashSet<ChainId>>

A collection of chains which restrict the origin of messages to be accepted. Option::None means that messages from all chains are accepted. An empty HashSet denotes that messages from no chains are accepted.

ignore_chain_ids: HashSet<ChainId>

A collection of chains whose incoming messages should be ignored.

reject_message_bundles_without_application_ids: Option<HashSet<GenericApplicationId>>

A collection of applications: If Some, only bundles with at least one message by any of these applications will be accepted.

reject_message_bundles_with_other_application_ids: Option<HashSet<GenericApplicationId>>

A collection of applications: If Some, only bundles all of whose messages are by these applications will be accepted.

process_events_from_application_ids: Option<HashSet<GenericApplicationId>>

A collection of applications: If Some, only event streams from those applications will be processed.

never_reject_application_ids: HashSet<GenericApplicationId>

A collection of applications whose messages must never be rejected. Bundles whose messages are all from one of these applications bypass the other rejection rules (except restrict_chain_ids_to), and on execution failure they are discarded for later retry instead of being rejected. A bundle that contains any message from an application not on this list can be rejected. An empty set disables this feature.

Implementations

impl MessagePolicy

pub async fn blanket( &self, ctx: &ContextBase<'_, &Positioned<Field>>, ) -> Result<&BlanketMessagePolicy, Error>

pub async fn restrict_chain_ids_to( &self, ctx: &ContextBase<'_, &Positioned<Field>>, ) -> Result<&Option<HashSet<ChainId>>, Error>

pub async fn ignore_chain_ids( &self, ctx: &ContextBase<'_, &Positioned<Field>>, ) -> Result<&HashSet<ChainId>, Error>

pub async fn reject_message_bundles_without_application_ids( &self, ctx: &ContextBase<'_, &Positioned<Field>>, ) -> Result<&Option<HashSet<GenericApplicationId>>, Error>

pub async fn reject_message_bundles_with_other_application_ids( &self, ctx: &ContextBase<'_, &Positioned<Field>>, ) -> Result<&Option<HashSet<GenericApplicationId>>, Error>

pub async fn process_events_from_application_ids( &self, ctx: &ContextBase<'_, &Positioned<Field>>, ) -> Result<&Option<HashSet<GenericApplicationId>>, Error>

pub async fn never_reject_application_ids( &self, ctx: &ContextBase<'_, &Positioned<Field>>, ) -> Result<&HashSet<GenericApplicationId>, Error>

impl MessagePolicy

pub fn is_ignore(&self) -> bool

Returns true if the blanket policy is to ignore messages.

pub fn is_reject(&self) -> bool

Returns true if the blanket policy is to reject messages.

pub fn ignores_origin(&self, origin: &ChainId) -> bool

Returns true if every message from origin would be unconditionally dropped: blanket policy is Ignore, the origin is in ignore_chain_ids, or restrict_chain_ids_to is Some and does not contain the origin.

Trait Implementations

impl Clone for MessagePolicy

fn clone(&self) -> MessagePolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainerType for MessagePolicy

async fn resolve_field( &self, ctx: &ContextBase<'_, &Positioned<Field>>, ) -> Result<Option<ConstValue>, ServerError>

Resolves a field value and outputs it as a json value async_graphql::Value.

fn collect_all_fields<'a>( &'a self, ctx: &ContextBase<'a, &'a Positioned<SelectionSet>>, fields: &mut Fields<'a>, ) -> Result<(), ServerError>

where Self: Send + Sync,

Collect all the fields of the container that are queried in the selection set.

fn find_entity( &self, _: &ContextBase<'_, &Positioned<Field>>, _params: &ConstValue, ) -> impl Future<Output = Result<Option<ConstValue>, ServerError>> + Send

Find the GraphQL entity with the given name from the parameter.

impl Debug for MessagePolicy

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

Formats the value using the given formatter.

impl Default for MessagePolicy

fn default() -> MessagePolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessagePolicy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl OutputType for MessagePolicy

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

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

async fn resolve( &self, ctx: &ContextBase<'_, &Positioned<SelectionSet>>, _field: &Positioned<Field>, ) -> Result<ConstValue, ServerError>

Resolve an output value to async_graphql::Value.

fn qualified_type_name() -> String

Qualified typename.

fn introspection_type_name(&self) -> Cow<'static, str>

Introspection type name

impl PartialEq for MessagePolicy

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ObjectType for MessagePolicy

impl StructuralPartialEq for MessagePolicy