Struct kittycad_modeling_cmds::websocket::ModelingBatch

pub struct ModelingBatch {
    pub requests: Vec<ModelingCmdReq>,
    pub batch_id: ModelingCmdId,
    pub responses: bool,
}

A sequence of modeling requests. If any request fails, following requests will not be tried.

Fields

requests: Vec<ModelingCmdReq>

A sequence of modeling requests. If any request fails, following requests will not be tried.

batch_id: ModelingCmdId

ID of batch being submitted. Each request has their own individual ModelingCmdId, but this is the ID of the overall batch.

responses: bool

If false or omitted, responses to each batch command will just be Ok(()). If true, responses will be the actual response data for that modeling command.

Implementations

impl ModelingBatch

pub fn push(&mut self, req: ModelingCmdReq)

Add a new modeling command to the end of this batch.

pub fn is_empty(&self) -> bool

Are there any requests in the batch?

Trait Implementations

impl Debug for ModelingBatch

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

Formats the value using the given formatter.

impl Default for ModelingBatch

fn default() -> Self

Creates a batch with 0 requests and a random ID.

impl<'de> Deserialize<'de> for ModelingBatch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ModelingBatch

fn schema_name() -> String

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for ModelingBatch

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

where __S: Serializer,

Serialize this value into the given Serde serializer.