Skip to main content

PrintAction

printobserver_sdk::contract

Enum PrintAction

pub enum PrintAction {
    Pause {
        actor: Actor,
        reason: String,
    },
    Resume {
        actor: Actor,
        reason: String,
    },
    Cancel {
        actor: Actor,
        reason: String,
    },
    StartPrint {
        actor: Actor,
        file_name: FileName,
        manifest: JobManifest,
        override_filament_check: Option<bool>,
        reason: String,
    },
    SetFeedrateFactor {
        actor: Actor,
        duration_s: Option<i64>,
        factor: f64,
        reason: String,
    },
    SetFlowrateFactor {
        actor: Actor,
        duration_s: Option<i64>,
        factor: f64,
        reason: String,
    },
    SetToolTargetC {
        actor: Actor,
        duration_s: Option<i64>,
        reason: String,
        target_c: f64,
        tool: i64,
    },
    SetBedTargetC {
        actor: Actor,
        duration_s: Option<i64>,
        reason: String,
        target_c: f64,
    },
    SetFanPercent {
        actor: Actor,
        duration_s: Option<i64>,
        percent: f64,
        reason: String,
    },
    AcknowledgeFailure {
        actor: Actor,
        disposition: AcknowledgementDisposition,
        event_id: EventId,
        reason: String,
    },
}

Expand description

The whole vocabulary an actor may ask for, and there is no other.

Variants§

Pause

Pause the print.

Fields

§actor: Actor

Who is asking.

§reason: String

Why the actor is asking for this.

Resume

Resume the print.

Fields

§actor: Actor

Who is asking.

§reason: String

Why the actor is asking for this.

Cancel

Cancel the print.

Fields

§actor: Actor

Who is asking.

§reason: String

Why the actor is asking for this.

StartPrint

Start a print of a named file, with a manifest.

Fields

§actor: Actor

Who is asking.

§file_name: FileName

The file to print, validated as a name a file API can be asked for.

§manifest: JobManifest

The manifest this print is bounded by.

§override_filament_check: Option<bool>

Start despite an insufficient or unverified spool, or a file OctoPrint has not analysed; the start’s own reason is the override’s reason.

§reason: String

Why the actor is asking for this.

SetFeedrateFactor

Set the feedrate factor, where one means one hundred percent.

Fields

§actor: Actor

Who is asking.

§duration_s: Option<i64>

How long the change stands for, in whole seconds.

§factor: f64

The multiplier asked for.

§reason: String

Why the actor is asking for this.

SetFlowrateFactor

Set the flowrate factor, where one means one hundred percent.

Fields

§actor: Actor

Who is asking.

§duration_s: Option<i64>

How long the change stands for, in whole seconds.

§factor: f64

The multiplier asked for.

§reason: String

Why the actor is asking for this.

SetToolTargetC

Set one tool’s target temperature.

Fields

§actor: Actor

Who is asking.

§duration_s: Option<i64>

How long the change stands for, in whole seconds.

§reason: String

Why the actor is asking for this.

§target_c: f64

The target temperature asked for, in degrees Celsius.

§tool: i64

The tool, in the printer’s own numbering.

SetBedTargetC

Set the bed’s target temperature.

Fields

§actor: Actor

Who is asking.

§duration_s: Option<i64>

How long the change stands for, in whole seconds.

§reason: String

Why the actor is asking for this.

§target_c: f64

The target temperature asked for, in degrees Celsius.

SetFanPercent

Set the part-cooling fan percentage.

Fields

§actor: Actor

Who is asking.

§duration_s: Option<i64>

How long the change stands for, in whole seconds.

§percent: f64

The percentage asked for.

§reason: String

Why the actor is asking for this.

AcknowledgeFailure

Acknowledge a failure event, with a disposition.

Fields

§actor: Actor

Who is asking.

§disposition: AcknowledgementDisposition

What to do next.

§event_id: EventId

The event being acknowledged.

§reason: String

Why the actor is asking for this.

Trait Implementations§

impl Clone for PrintAction

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for PrintAction

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for PrintAction

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for PrintAction

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl Serialize for PrintAction

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for PrintAction

Auto Trait Implementations§

impl Freeze for PrintAction

impl RefUnwindSafe for PrintAction

impl Send for PrintAction

impl Sync for PrintAction

impl Unpin for PrintAction

impl UnsafeUnpin for PrintAction

impl UnwindSafe for PrintAction

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.