Struct SandboxConfiguration

#[repr(C)]
pub struct SandboxConfiguration { /* private fields */ }

The complete set of configuration needed to create a Sandbox

Implementations

impl SandboxConfiguration

pub const DEFAULT_INPUT_SIZE: usize = 16_384usize

The default size of input data

pub const MIN_INPUT_SIZE: usize = 8_192usize

The minimum size of input data

pub const DEFAULT_OUTPUT_SIZE: usize = 16_384usize

The default size of output data

pub const MIN_OUTPUT_SIZE: usize = 8_192usize

The minimum size of output data

pub const DEFAULT_HOST_FUNCTION_DEFINITION_SIZE: usize = 4_096usize

The default size of host function definitions Host function definitions has its own page in memory, in order to be READ-ONLY from a guest’s perspective.

pub const MIN_HOST_FUNCTION_DEFINITION_SIZE: usize = 4_096usize

The minimum size of host function definitions

pub const DEFAULT_HOST_EXCEPTION_SIZE: usize = 16_384usize

The default size for host exceptions

pub const MIN_HOST_EXCEPTION_SIZE: usize = 16_384usize

The minimum size for host exceptions

pub const DEFAULT_GUEST_ERROR_BUFFER_SIZE: usize = 256usize

The default size for guest error messages

pub const MIN_GUEST_ERROR_BUFFER_SIZE: usize = 128usize

The minimum size for guest error messages

pub const DEFAULT_MAX_INITIALIZATION_TIME: u16 = 2_000u16

The default value for max initialization time (in milliseconds)

pub const MIN_MAX_INITIALIZATION_TIME: u16 = 1u16

The minimum value for max initialization time (in milliseconds)

pub const MAX_MAX_INITIALIZATION_TIME: u16 = 65_535u16

The maximum value for max initialization time (in milliseconds)

pub const DEFAULT_MAX_EXECUTION_TIME: u16 = 1_000u16

The default and minimum values for max execution time (in milliseconds)

pub const MIN_MAX_EXECUTION_TIME: u16 = 1u16

The minimum value for max execution time (in milliseconds)

pub const MAX_MAX_EXECUTION_TIME: u16 = 65_535u16

The maximum value for max execution time (in milliseconds)

pub const DEFAULT_MAX_WAIT_FOR_CANCELLATION: u8 = 100u8

The default and minimum values for max wait for cancellation (in milliseconds)

pub const MIN_MAX_WAIT_FOR_CANCELLATION: u8 = 10u8

The minimum value for max wait for cancellation (in milliseconds)

pub const MAX_MAX_WAIT_FOR_CANCELLATION: u8 = 255u8

The maximum value for max wait for cancellation (in milliseconds)

pub const DEFAULT_GUEST_PANIC_CONTEXT_BUFFER_SIZE: usize = 1_024usize

The default and minimum values for guest panic context data

pub const MIN_GUEST_PANIC_CONTEXT_BUFFER_SIZE: usize = 1_024usize

The minimum value for guest panic context data

pub const MIN_KERNEL_STACK_SIZE: usize = 4_096usize

The minimum value for kernel stack size

pub const DEFAULT_KERNEL_STACK_SIZE: usize = 4_096usize

The default value for kernel stack size

pub fn set_input_data_size(&mut self, input_data_size: usize)

Set the size of the memory buffer that is made available for input to the guest the minimum value is MIN_INPUT_SIZE

pub fn set_output_data_size(&mut self, output_data_size: usize)

Set the size of the memory buffer that is made available for output from the guest the minimum value is MIN_OUTPUT_SIZE

pub fn set_host_function_definition_size( &mut self, host_function_definition_size: usize, )

Set the size of the memory buffer that is made available for serialising host function definitions the minimum value is MIN_HOST_FUNCTION_DEFINITION_SIZE

pub fn set_host_exception_size(&mut self, host_exception_size: usize)

Set the size of the memory buffer that is made available for serialising host exceptions the minimum value is MIN_HOST_EXCEPTION_SIZE

pub fn set_guest_error_buffer_size(&mut self, guest_error_buffer_size: usize)

Set the size of the memory buffer that is made available for serialising guest error messages the minimum value is MIN_GUEST_ERROR_BUFFER_SIZE

pub fn set_stack_size(&mut self, stack_size: u64)

Set the stack size to use in the guest sandbox. If set to 0, the stack size will be determined from the PE file header

pub fn set_heap_size(&mut self, heap_size: u64)

Set the heap size to use in the guest sandbox. If set to 0, the heap size will be determined from the PE file header

pub fn set_kernel_stack_size(&mut self, kernel_stack_size: usize)

Set the kernel stack size to use in the guest sandbox. If less than the minimum value of MIN_KERNEL_STACK_SIZE, the minimum value will be used. If its not a multiple of the page size, it will be increased to the a multiple of the page size when memory is allocated.

pub fn set_max_execution_time(&mut self, max_execution_time: Duration)

Set the maximum execution time of a guest function execution. If set to 0, the max_execution_time will be set to the default value of DEFAULT_MAX_EXECUTION_TIME if the guest execution does not complete within the time specified then the execution will be cancelled, the minimum value is MIN_MAX_EXECUTION_TIME

pub fn set_max_execution_cancel_wait_time( &mut self, max_wait_for_cancellation: Duration, )

Set the maximum time to wait for guest execution calculation. If set to 0, the maximum cancellation time will be set to the default value of DEFAULT_MAX_WAIT_FOR_CANCELLATION if the guest execution cancellation does not complete within the time specified then an error will be returned, the minimum value is MIN_MAX_WAIT_FOR_CANCELLATION

pub fn set_max_initialization_time(&mut self, max_initialization_time: Duration)

Set the maximum time to wait for guest initialization. If set to 0, the maximum initialization time will be set to the default value of DEFAULT_MAX_INITIALIZATION_TIME if the guest initialization does not complete within the time specified then an error will be returned, the minimum value is MIN_MAX_INITIALIZATION_TIME

pub fn set_guest_panic_context_buffer_size( &mut self, guest_panic_context_buffer_size: usize, )

Set the size of the memory buffer that is made available for serializing guest panic context the minimum value is MIN_GUEST_PANIC_CONTEXT_BUFFER_SIZE

Trait Implementations

impl Clone for SandboxConfiguration

fn clone(&self) -> SandboxConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SandboxConfiguration

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

Formats the value using the given formatter.

impl Default for SandboxConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for SandboxConfiguration

fn eq(&self, other: &SandboxConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SandboxConfiguration

impl Eq for SandboxConfiguration

impl StructuralPartialEq for SandboxConfiguration