Struct SetShot 

pub struct SetShot {
    pub shot_id: ShotId,
    pub library_id: String,
    pub streamer_id: String,
    pub name: String,
    pub kind: ShotKind,
    pub target_name: String,
    pub translation_speed_cm_s: f32,
    pub rotation_speed_deg_s: f32,
    pub hold_duration_ms: u64,
    pub travel_duration_ms: u64,
    pub default_entry_mode: ShotEntryMode,
    pub shot_index: u32,
}

Upsert one persistent shot definition. The stable shot ID is supplied by the client so reconnects cannot create duplicate definitions for the same target.

Fields

shot_id: ShotId

library_id: String

streamer_id: String

name: String

kind: ShotKind

target_name: String

translation_speed_cm_s: f32

rotation_speed_deg_s: f32

hold_duration_ms: u64

travel_duration_ms: u64

default_entry_mode: ShotEntryMode

shot_index: u32

Persistent shot label. Keep the established wire name so currently deployed clients remain compatible while Rust uses the correct taxonomy.

Implementations

impl SetShot

pub fn new(args: SetShotArgs) -> Self

pub fn handle( &self, client: &MykoClient, ) -> Cell<Option<Result<ShotId, String>>, CellImmutable>

Trait Implementations

impl Clone for SetShot

fn clone(&self) -> SetShot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandHandler for SetShot

fn execute(self, ctx: CommandContext) -> Result<ShotId, CommandError>

Execute the command synchronously.

impl CommandId for &SetShot

fn command_id(&self) -> Arc<str>

impl CommandId for SetShot

fn command_id(&self) -> Arc<str>

impl CommandIdStatic for SetShot

const COMMAND_ID: &'static str = "SetShot"

The command ID as a const string (usable in static contexts)

fn command_id_static() -> &'static str

Get the command ID (convenience method, defaults to COMMAND_ID)

impl CommandResultType for SetShot

type Result = ShotId

impl Debug for SetShot

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SetShot

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SetShot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for SetShot

type WithoutGenerics = SetShot

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = SetShot

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.