Skip to main content

Bom

Struct Bom 

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

Bill of Materials operations.

Access via commerce.bom().

§Example

use stateset_embedded::{Commerce, CreateBom, CreateBomComponent, ProductId};
use rust_decimal_macros::dec;

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

// Create a BOM
let bom = commerce.bom().create(CreateBom {
    product_id: ProductId::new(),
    name: "Widget Assembly".into(),
    description: Some("Assembly instructions for widget".into()),
    components: Some(vec![
        CreateBomComponent {
            name: "Screw M3x10".into(),
            component_sku: Some("SCREW-M3-10".into()),
            quantity: dec!(4),
            ..Default::default()
        },
    ]),
    ..Default::default()
})?;

Implementations§

Source§

impl Bom

Source

pub fn create(&self, input: CreateBom) -> Result<BillOfMaterials>

Create a new Bill of Materials.

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

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

let bom = commerce.bom().create(CreateBom {
    product_id: ProductId::new(),
    name: "Widget Assembly".into(),
    components: Some(vec![
        CreateBomComponent {
            name: "Part A".into(),
            quantity: dec!(2),
            ..Default::default()
        },
    ]),
    ..Default::default()
})?;
Source

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

Get a BOM by ID.

Source

pub fn get_by_number(&self, bom_number: &str) -> Result<Option<BillOfMaterials>>

Get a BOM by its BOM number.

Source

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

Update a BOM.

Source

pub fn list(&self, filter: BomFilter) -> Result<Vec<BillOfMaterials>>

List BOMs with optional filter.

Source

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

Delete a BOM (marks as obsolete).

Source

pub fn add_component( &self, bom_id: Uuid, component: CreateBomComponent, ) -> Result<BomComponent>

Add a component to a BOM.

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

let commerce = Commerce::new(":memory:")?;
let bom_id = Uuid::new_v4(); // Existing BOM ID

let component = commerce.bom().add_component(bom_id, CreateBomComponent {
    name: "Resistor 10K".into(),
    component_sku: Some("RES-10K".into()),
    quantity: dec!(4),
    position: Some("R1, R2, R3, R4".into()),
    ..Default::default()
})?;
Source

pub fn update_component( &self, component_id: Uuid, component: CreateBomComponent, ) -> Result<BomComponent>

Update a component in a BOM.

Source

pub fn remove_component(&self, component_id: Uuid) -> Result<()>

Remove a component from a BOM.

Source

pub fn get_components(&self, bom_id: Uuid) -> Result<Vec<BomComponent>>

Get all components for a BOM.

Source

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

Activate a BOM (make it ready for production use).

Changes the BOM status from Draft to Active.

Source

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

Count BOMs matching filter.

Source

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

Get BOMs for a specific product.

Trait Implementations§

Source§

impl Debug for Bom

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Bom

§

impl !UnwindSafe for Bom

§

impl Freeze for Bom

§

impl Send for Bom

§

impl Sync for Bom

§

impl Unpin for Bom

§

impl UnsafeUnpin for Bom

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