Struct ContextPolicy 

pub struct ContextPolicy {
    pub priorities: Vec<Arc<dyn ContextKeySelector>>,
}

This is a configurable context policy based on priority.

Fields

priorities: Vec<Arc<dyn ContextKeySelector>>

The rules in order of priority.

Implementations

impl ContextPolicy

pub fn which_rule( &self, context_key: &ScriptAttachment, ) -> Option<&(dyn ContextKeySelector + 'static)>

Return which rule is used for context_key.

pub fn shared() -> ContextPolicy

Use a shared script context.

pub fn per_entity() -> ContextPolicy

Use one script context per entity or a shared context.

For example, given:

• script_id: Some("script1")
• entity: Some(1)

The context key will purely use the entity, resulting in a context key of ContextKey { entity: Some(1) }.

resulting in each entity having its own context regardless of the script id.

static scripts will get their own context per script asset.

The default is then to use a shared context for no matches

pub fn per_script() -> ContextPolicy

Use one script context per script or a shared context.

For example, given:

• script_id: Some("script1")
• entity: Some(1)

The context key will purely use the script, resulting in a context key of ContextKey { script: Some("script1") }.

resulting in each script having its own context regardless of the entity.

If no script is given it will be the default, i.e. shared context.

pub fn per_entity_and_script() -> ContextPolicy

Use one script context per entity-script, or a script context, or a shared context.

For example, given:

• script_id: Some("script1")
• entity: Some(1)

The context key will use the entity-script pair, resulting in a context key of ContextKey { entity: Some(1), script: Some("script1") }.

resulting in each entity-script combination having its own context.

If no entity-script pair is given it will be the default, i.e. shared context.

Trait Implementations

impl Clone for ContextPolicy

fn clone(&self) -> ContextPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContextKeySelector for ContextPolicy

fn select(&self, context_key: &ScriptAttachment) -> Option<ContextKey>

The given context key represents a possible script, entity that is requesting a context.

impl Debug for ContextPolicy

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

Formats the value using the given formatter.

impl Default for ContextPolicy

Returns a default context policy. i.e. [ContextPolicy::per_entity_and_script].

fn default() -> ContextPolicy

Returns the “default value” for a type.