Struct re_log_types::BlueprintActivationCommand

pub struct BlueprintActivationCommand {
    pub blueprint_id: StoreId,
    pub make_active: bool,
    pub make_default: bool,
}

Command used for activating a blueprint once it has been fully transmitted.

This command serves two purposes:

• It is important that a blueprint is never activated before it has been fully transmitted. Displaying, or allowing a user to modify, a half-transmitted blueprint can cause confusion and bad interactions with the space view heuristics.
• Additionally, this command allows fine-tuning the activation behavior itself by specifying whether the blueprint should be immediately activated, or only become the default for future activations.

Fields

blueprint_id: StoreId

The blueprint this command refers to.

make_active: bool

Immediately make this the active blueprint for the associated app_id.

Note that setting this to false does not mean the blueprint may not still end up becoming active. In particular, if make_default is true and there is no other currently active blueprint.

make_default: bool

Make this the default blueprint for the app_id.

The default blueprint will be used as the template when the user resets the blueprint for the app. It will also become the active blueprint if no other blueprint is currently active.

Implementations

impl BlueprintActivationCommand

pub fn make_default(blueprint_id: StoreId) -> Self

Make blueprint_id the default blueprint for its associated app_id.

pub fn make_active(blueprint_id: StoreId) -> Self

Immediately make blueprint_id the active blueprint for its associated app_id.

This also sets make_default to true.

Trait Implementations

impl Clone for BlueprintActivationCommand

fn clone(&self) -> BlueprintActivationCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlueprintActivationCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BlueprintActivationCommand

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BlueprintActivationCommand> for LogMsg

fn from(value: BlueprintActivationCommand) -> Self

Converts to this type from the input type.

impl PartialEq for BlueprintActivationCommand

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BlueprintActivationCommand

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 BlueprintActivationCommand

impl StructuralPartialEq for BlueprintActivationCommand