IFlowOptions

Struct IFlowOptions 

Source
pub struct IFlowOptions {
    pub cwd: PathBuf,
    pub mcp_servers: Vec<McpServer>,
    pub timeout: f64,
    pub metadata: HashMap<String, Value>,
    pub file_access: FileAccessConfig,
    pub process: ProcessConfig,
    pub auth_method_id: Option<String>,
    pub logging: LoggingConfig,
    pub websocket: Option<WebSocketConfig>,
    pub permission_mode: PermissionMode,
}
Expand description

Configuration options for iFlow SDK

This struct contains all the configuration options for the iFlow SDK, including connection settings, security options, and logging configuration.

Fields§

§cwd: PathBuf

Current working directory

§mcp_servers: Vec<McpServer>

MCP servers to connect to

§timeout: f64

Request timeout in seconds

§metadata: HashMap<String, Value>

Additional metadata to include in requests

§file_access: FileAccessConfig

File access configuration

§process: ProcessConfig

Process management configuration

§auth_method_id: Option<String>

Authentication method ID

§logging: LoggingConfig

Logging configuration

§websocket: Option<WebSocketConfig>

WebSocket configuration (if None, use stdio)

§permission_mode: PermissionMode

Permission mode for tool calls

Implementations§

Source§

impl IFlowOptions

Source

pub fn new() -> Self

Create a new IFlowOptions instance with default values

Source

pub fn with_cwd(self, cwd: PathBuf) -> Self

Set the current working directory

§Arguments
  • cwd - The current working directory
Source

pub fn with_timeout(self, timeout: f64) -> Self

Set the request timeout

§Arguments
  • timeout - Timeout in seconds
Source

pub fn with_mcp_servers(self, servers: Vec<McpServer>) -> Self

Set MCP servers to connect to

§Arguments
  • servers - The MCP servers to connect to
Source

pub fn with_metadata(self, metadata: HashMap<String, Value>) -> Self

Set additional metadata to include in requests

§Arguments
  • metadata - The metadata to include
Source

pub fn with_file_access_config(self, config: FileAccessConfig) -> Self

Set file access configuration

§Arguments
  • config - The file access configuration
Source

pub fn with_process_config(self, config: ProcessConfig) -> Self

Set process management configuration

§Arguments
  • config - The process management configuration
Source

pub fn with_auto_start(self, auto_start: bool) -> Self

Set auto start process

§Arguments
  • auto_start - Whether to automatically start the iFlow process
Source

pub fn with_auth_method_id(self, method_id: String) -> Self

Set authentication method ID

§Arguments
  • method_id - The authentication method ID
Source

pub fn with_logging_config(self, config: LoggingConfig) -> Self

Set logging configuration

§Arguments
  • config - The logging configuration
Source

pub fn with_websocket_config(self, config: WebSocketConfig) -> Self

Set WebSocket configuration

§Arguments
  • config - The WebSocket configuration
Source

pub fn with_permission_mode(self, mode: PermissionMode) -> Self

Set permission mode for tool calls

§Arguments
  • mode - The permission mode to use

Trait Implementations§

Source§

impl Clone for IFlowOptions

Source§

fn clone(&self) -> IFlowOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IFlowOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IFlowOptions

Source§

fn default() -> Self

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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
Source§

impl<T> ErasedDestructor for T
where T: 'static,