Skip to main content

WorkOrders

Struct WorkOrders 

Source
pub struct WorkOrders { /* private fields */ }
Expand description

Work Order operations.

Access via commerce.work_orders().

§Example

use stateset_embedded::{Commerce, CreateWorkOrder, CreateWorkOrderTask, ProductId};
use rust_decimal_macros::dec;

let commerce = Commerce::new("./store.db")?;

// Create a work order
let wo = commerce.work_orders().create(CreateWorkOrder {
    product_id: ProductId::new(),
    quantity_to_build: dec!(100),
    tasks: Some(vec![
        CreateWorkOrderTask {
            task_name: "Assembly".into(),
            sequence: Some(1),
            estimated_hours: Some(dec!(2)),
            ..Default::default()
        },
    ]),
    ..Default::default()
})?;

// Start the work order
let wo = commerce.work_orders().start(wo.id)?;

// Complete with quantity
let wo = commerce.work_orders().complete(wo.id, dec!(100))?;

Implementations§

Source§

impl WorkOrders

Source

pub fn create(&self, input: CreateWorkOrder) -> Result<WorkOrder>

Create a new work order.

§Example
use stateset_embedded::{Commerce, CreateWorkOrder, ProductId};
use rust_decimal_macros::dec;

let commerce = Commerce::new(":memory:")?;

let wo = commerce.work_orders().create(CreateWorkOrder {
    product_id: ProductId::new(),
    quantity_to_build: dec!(50),
    notes: Some("Rush order".into()),
    ..Default::default()
})?;
Source

pub fn get(&self, id: Uuid) -> Result<Option<WorkOrder>>

Get a work order by ID.

Source

pub fn get_by_number( &self, work_order_number: &str, ) -> Result<Option<WorkOrder>>

Get a work order by its work order number.

Source

pub fn update(&self, id: Uuid, input: UpdateWorkOrder) -> Result<WorkOrder>

Update a work order.

Source

pub fn list(&self, filter: WorkOrderFilter) -> Result<Vec<WorkOrder>>

List work orders with optional filter.

Source

pub fn delete(&self, id: Uuid) -> Result<()>

Delete a work order (cancels if not started).

Source

pub fn start(&self, id: Uuid) -> Result<WorkOrder>

Start a work order.

Transitions the work order from Planned to InProgress and records the actual start time.

§Example
use stateset_embedded::Commerce;
use uuid::Uuid;

let commerce = Commerce::new(":memory:")?;
let wo_id = Uuid::new_v4(); // Existing work order ID

let wo = commerce.work_orders().start(wo_id)?;
assert_eq!(wo.status.to_string(), "in_progress");
Source

pub fn complete( &self, id: Uuid, quantity_completed: Decimal, ) -> Result<WorkOrder>

Complete a work order with the quantity produced.

If the quantity meets or exceeds the target, the order is marked as Completed. Otherwise, it’s marked as PartiallyCompleted.

§Example
use stateset_embedded::Commerce;
use rust_decimal_macros::dec;
use uuid::Uuid;

let commerce = Commerce::new(":memory:")?;
let wo_id = Uuid::new_v4(); // Existing work order ID

// Complete with full quantity
let wo = commerce.work_orders().complete(wo_id, dec!(100))?;
Source

pub fn hold(&self, id: Uuid) -> Result<WorkOrder>

Put a work order on hold.

Source

pub fn resume(&self, id: Uuid) -> Result<WorkOrder>

Resume a held work order.

Source

pub fn cancel(&self, id: Uuid) -> Result<WorkOrder>

Cancel a work order.

Source

pub fn add_task( &self, work_order_id: Uuid, task: CreateWorkOrderTask, ) -> Result<WorkOrderTask>

Add a task to a work order.

§Example
use stateset_embedded::{Commerce, CreateWorkOrderTask};
use rust_decimal_macros::dec;
use uuid::Uuid;

let commerce = Commerce::new(":memory:")?;
let wo_id = Uuid::new_v4(); // Existing work order ID

let task = commerce.work_orders().add_task(wo_id, CreateWorkOrderTask {
    task_name: "Quality Check".into(),
    sequence: Some(10),
    estimated_hours: Some(dec!(0.5)),
    ..Default::default()
})?;
Source

pub fn update_task( &self, task_id: Uuid, task: UpdateWorkOrderTask, ) -> Result<WorkOrderTask>

Update a task.

Source

pub fn remove_task(&self, task_id: Uuid) -> Result<()>

Remove a task from a work order.

Source

pub fn get_tasks(&self, work_order_id: Uuid) -> Result<Vec<WorkOrderTask>>

Get all tasks for a work order.

Source

pub fn start_task(&self, task_id: Uuid) -> Result<WorkOrderTask>

Start a task.

Source

pub fn complete_task( &self, task_id: Uuid, actual_hours: Option<Decimal>, ) -> Result<WorkOrderTask>

Complete a task with optional actual hours.

Source

pub fn add_material( &self, work_order_id: Uuid, material: AddWorkOrderMaterial, ) -> Result<WorkOrderMaterial>

Add material to a work order.

§Example
use stateset_embedded::{Commerce, AddWorkOrderMaterial};
use rust_decimal_macros::dec;
use uuid::Uuid;

let commerce = Commerce::new(":memory:")?;
let wo_id = Uuid::new_v4(); // Existing work order ID

let material = commerce.work_orders().add_material(wo_id, AddWorkOrderMaterial {
    component_sku: "SCREW-M3".into(),
    component_name: "M3 Screw".into(),
    quantity: dec!(200),
    ..Default::default()
})?;
Source

pub fn consume_material( &self, material_id: Uuid, quantity: Decimal, ) -> Result<WorkOrderMaterial>

Consume material during production.

Records that a certain quantity of material has been used.

Source

pub fn get_materials( &self, work_order_id: Uuid, ) -> Result<Vec<WorkOrderMaterial>>

Get all materials for a work order.

Source

pub fn count(&self, filter: WorkOrderFilter) -> Result<u64>

Count work orders matching filter.

Source

pub fn for_product(&self, product_id: ProductId) -> Result<Vec<WorkOrder>>

Get work orders for a specific product.

Source

pub fn for_bom(&self, bom_id: Uuid) -> Result<Vec<WorkOrder>>

Get work orders using a specific BOM.

Trait Implementations§

Source§

impl Debug for WorkOrders

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more