Struct SessionBuilder

Source

pub struct SessionBuilder {
    pub client: Client,
    pub fps: Option<u32>,
    pub unlocked_framerate: Option<bool>,
    pub video_res_height: Option<u32>,
    pub video_res_width: Option<u32>,
    pub buffer_reqs: Option<usize>,
    pub await_response_timeout: Option<Duration>,
    pub show_grid: Option<bool>,
}

Expand description

Parameters for starting a session with the KittyCAD Modeling API.

Fields§

§client: Client

Client to the KittyCAD API.

§fps: Option<u32>

Frames per second of the video feed.

§unlocked_framerate: Option<bool>

If true, engine will render video frames as fast as it can.

§video_res_height: Option<u32>

Height of the video feed. Must be a multiple of 4.

§video_res_width: Option<u32>

Width of the video feed. Must be a multiple of 4.

§buffer_reqs: Option<usize>

How many requests for sending/receiving to/from the API can be in-flight at once.

§await_response_timeout: Option<Duration>

How long to wait for the response to a modeling command. Defaults to 10 seconds.

§show_grid: Option<bool>

Show the grid?

Auto Trait Implementations§

§

impl !UnwindSafe for SessionBuilder

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> FutureExt for T

Source §

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

Source §

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §