Struct ClassBuilder 

pub struct ClassBuilder { /* private fields */ }

Builder for class types

Note: All methods are fallible because the underlying class could be deleted while you hold a reference to the builder.

Implementations

impl ClassBuilder

pub fn add_property( &self, name: &str, field_type: &TypeDef, ) -> Result<ClassPropertyBuilder, BamlError>

Add a property to this class

pub fn get_property(&self, name: &str) -> Option<ClassPropertyBuilder>

Get a property by name (if it exists)

pub fn list_properties(&self) -> Result<Vec<ClassPropertyBuilder>, BamlError>

List all properties

pub fn as_type(&self) -> Result<TypeDef, BamlError>

Get this class as a Type

pub fn name(&self) -> Result<String, BamlError>

Get the class name

pub fn set_description(&self, description: &str) -> Result<(), BamlError>

Set description for LLM

pub fn description(&self) -> Result<Option<String>, BamlError>

Get description (if set)

pub fn set_alias(&self, alias: &str) -> Result<(), BamlError>

Set alias for LLM

pub fn alias(&self) -> Result<Option<String>, BamlError>

Get alias (if set)

Trait Implementations

impl BamlEncode for ClassBuilder

fn baml_encode(&self) -> HostValue

Encode to a HostValue (inbound schema)

impl Clone for ClassBuilder

fn clone(&self) -> ClassBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.