Struct tinkerforge::red_brick::RedBrick

pub struct RedBrick { /* private fields */ }

Executes user programs and controls other Bricks/Bricklets standalone

Implementations

impl RedBrick

pub const DEVICE_IDENTIFIER: u16 = 17u16

pub const DEVICE_DISPLAY_NAME: &'static str = "RED Brick"

pub fn new(uid: &str, ip_connection: &IpConnection) -> RedBrick

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected(
    &mut self,
    fun: RedBrickFunction
) -> Result<bool, GetResponseExpectedError>

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected(
    &mut self,
    fun: RedBrickFunction,
    response_expected: bool
) -> Result<(), SetResponseExpectedError>

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

pub fn set_response_expected_all(&mut self, response_expected: bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

pub fn get_async_file_read_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<AsyncFileReadEvent>

This receiver reports the result of a call to the Read File Async function.

pub fn get_async_file_write_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<AsyncFileWriteEvent>

This receiver reports the result of a call to the Write File Async function.

pub fn get_file_events_occurred_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<FileEventsOccurredEvent>

pub fn get_process_state_changed_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<ProcessStateChangedEvent>

pub fn get_program_scheduler_state_changed_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u16>

pub fn get_program_process_spawned_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u16>

pub fn create_session(&self, lifetime: u32) -> ConvertingReceiver<CreateSession>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn expire_session(&self, session_id: u16) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn expire_session_unchecked(&self, session_id: u16) -> ConvertingReceiver<()>

pub fn keep_session_alive(
    &self,
    session_id: u16,
    lifetime: u32
) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn release_object(
    &self,
    object_id: u16,
    session_id: u16
) -> ConvertingReceiver<u8>

Decreases the reference count of an object by one and returns the resulting error code. If the reference count reaches zero the object gets destroyed.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn release_object_unchecked(
    &self,
    object_id: u16,
    session_id: u16
) -> ConvertingReceiver<()>

pub fn allocate_string(
    &self,
    length_to_reserve: u32,
    buffer: String,
    session_id: u16
) -> ConvertingReceiver<AllocateString>

Allocates a new string object, reserves length_to_reserve bytes memory for it and sets up to the first 60 bytes. Set length_to_reserve to the length of the string that should be stored in the string object.

Returns the object ID of the new string object and the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn truncate_string(
    &self,
    string_id: u16,
    length: u32
) -> ConvertingReceiver<u8>

Truncates a string object to length bytes and returns the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_string_length(
    &self,
    string_id: u16
) -> ConvertingReceiver<StringLength>

Returns the length of a string object in bytes and the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn set_string_chunk(
    &self,
    string_id: u16,
    offset: u32,
    buffer: String
) -> ConvertingReceiver<u8>

Sets a chunk of up to 58 bytes in a string object beginning at offset.

Returns the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_string_chunk(
    &self,
    string_id: u16,
    offset: u32
) -> ConvertingReceiver<StringChunk>

Returns a chunk up to 63 bytes from a string object beginning at offset and returns the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn allocate_list(
    &self,
    length_to_reserve: u16,
    session_id: u16
) -> ConvertingReceiver<AllocateList>

Allocates a new list object and reserves memory for length_to_reserve items. Set length_to_reserve to the number of items that should be stored in the list object.

Returns the object ID of the new list object and the resulting error code.

When a list object gets destroyed then the reference count of each object in the list object is decreased by one.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_list_length(&self, list_id: u16) -> ConvertingReceiver<ListLength>

Returns the length of a list object in items and the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_list_item(
    &self,
    list_id: u16,
    index: u16,
    session_id: u16
) -> ConvertingReceiver<ListItem>

Returns the object ID and type of the object stored at index in a list object and returns the resulting error code.

Possible object types are:

• String = 0
• List = 1
• File = 2
• Directory = 3
• Process = 4
• Program = 5

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES
• REDBRICK_OBJECT_TYPE_STRING
• REDBRICK_OBJECT_TYPE_LIST
• REDBRICK_OBJECT_TYPE_FILE
• REDBRICK_OBJECT_TYPE_DIRECTORY
• REDBRICK_OBJECT_TYPE_PROCESS
• REDBRICK_OBJECT_TYPE_PROGRAM

pub fn append_to_list(
    &self,
    list_id: u16,
    item_object_id: u16
) -> ConvertingReceiver<u8>

Appends an object to a list object and increases the reference count of the appended object by one.

Returns the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn remove_from_list(&self, list_id: u16, index: u16) -> ConvertingReceiver<u8>

Removes the object stored at index from a list object and decreases the reference count of the removed object by one.

Returns the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn open_file(
    &self,
    name_string_id: u16,
    flags: u32,
    permissions: u16,
    uid: u32,
    gid: u32,
    session_id: u16
) -> ConvertingReceiver<OpenFile>

Opens an existing file or creates a new file and allocates a new file object for it.

FIXME: name has to be absolute

The reference count of the name string object is increased by one. When the file object gets destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the file object holds a reference to it.

The flags parameter takes a ORed combination of the following possible file flags (in hexadecimal notation):

• ReadOnly = 0x0001 (O_RDONLY)
• WriteOnly = 0x0002 (O_WRONLY)
• ReadWrite = 0x0004 (O_RDWR)
• Append = 0x0008 (O_APPEND)
• Create = 0x0010 (O_CREAT)
• Exclusive = 0x0020 (O_EXCL)
• NonBlocking = 0x0040 (O_NONBLOCK)
• Truncate = 0x0080 (O_TRUNC)
• Temporary = 0x0100
• Replace = 0x0200

FIXME: explain Temporary and Replace flag

The permissions parameter takes a ORed combination of the following possible file permissions (in octal notation) that match the common UNIX permission bits:

• UserRead = 00400
• UserWrite = 00200
• UserExecute = 00100
• GroupRead = 00040
• GroupWrite = 00020
• GroupExecute = 00010
• OthersRead = 00004
• OthersWrite = 00002
• OthersExecute = 00001

Returns the object ID of the new file object and the resulting error code.

Associated constants:

• REDBRICK_FILE_FLAG_READ_ONLY
• REDBRICK_FILE_FLAG_WRITE_ONLY
• REDBRICK_FILE_FLAG_READ_WRITE
• REDBRICK_FILE_FLAG_APPEND
• REDBRICK_FILE_FLAG_CREATE
• REDBRICK_FILE_FLAG_EXCLUSIVE
• REDBRICK_FILE_FLAG_NON_BLOCKING
• REDBRICK_FILE_FLAG_TRUNCATE
• REDBRICK_FILE_FLAG_TEMPORARY
• REDBRICK_FILE_FLAG_REPLACE
• REDBRICK_FILE_PERMISSION_USER_ALL
• REDBRICK_FILE_PERMISSION_USER_READ
• REDBRICK_FILE_PERMISSION_USER_WRITE
• REDBRICK_FILE_PERMISSION_USER_EXECUTE
• REDBRICK_FILE_PERMISSION_GROUP_ALL
• REDBRICK_FILE_PERMISSION_GROUP_READ
• REDBRICK_FILE_PERMISSION_GROUP_WRITE
• REDBRICK_FILE_PERMISSION_GROUP_EXECUTE
• REDBRICK_FILE_PERMISSION_OTHERS_ALL
• REDBRICK_FILE_PERMISSION_OTHERS_READ
• REDBRICK_FILE_PERMISSION_OTHERS_WRITE
• REDBRICK_FILE_PERMISSION_OTHERS_EXECUTE
• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn create_pipe(
    &self,
    flags: u32,
    length: u64,
    session_id: u16
) -> ConvertingReceiver<CreatePipe>

Creates a new pipe and allocates a new file object for it.

The flags parameter takes a ORed combination of the following possible pipe flags (in hexadecimal notation):

• NonBlockingRead = 0x0001
• NonBlockingWrite = 0x0002

The length of the pipe buffer can be specified with the length parameter in bytes. If length is set to zero, then the default pipe buffer length is used.

Returns the object ID of the new file object and the resulting error code.

Associated constants:

• REDBRICK_PIPE_FLAG_NON_BLOCKING_READ
• REDBRICK_PIPE_FLAG_NON_BLOCKING_WRITE
• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_file_info(
    &self,
    file_id: u16,
    session_id: u16
) -> ConvertingReceiver<FileInfo>

Returns various information about a file and the resulting error code.

Possible file types are:

• Unknown = 0
• Regular = 1
• Directory = 2
• Character = 3
• Block = 4
• FIFO = 5
• Symlink = 6
• Socket = 7
• Pipe = 8

If the file type is Pipe then the returned name string object is invalid, because a pipe has no name. Otherwise the returned name string object was used to open or create the file object, as passed to Open File.

The returned flags were used to open or create the file object, as passed to Open File or Create Pipe. See the respective function for a list of possible file and pipe flags.

FIXME: everything except flags and length is invalid if file type is Pipe

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES
• REDBRICK_FILE_TYPE_UNKNOWN
• REDBRICK_FILE_TYPE_REGULAR
• REDBRICK_FILE_TYPE_DIRECTORY
• REDBRICK_FILE_TYPE_CHARACTER
• REDBRICK_FILE_TYPE_BLOCK
• REDBRICK_FILE_TYPE_FIFO
• REDBRICK_FILE_TYPE_SYMLINK
• REDBRICK_FILE_TYPE_SOCKET
• REDBRICK_FILE_TYPE_PIPE
• REDBRICK_FILE_PERMISSION_USER_ALL
• REDBRICK_FILE_PERMISSION_USER_READ
• REDBRICK_FILE_PERMISSION_USER_WRITE
• REDBRICK_FILE_PERMISSION_USER_EXECUTE
• REDBRICK_FILE_PERMISSION_GROUP_ALL
• REDBRICK_FILE_PERMISSION_GROUP_READ
• REDBRICK_FILE_PERMISSION_GROUP_WRITE
• REDBRICK_FILE_PERMISSION_GROUP_EXECUTE
• REDBRICK_FILE_PERMISSION_OTHERS_ALL
• REDBRICK_FILE_PERMISSION_OTHERS_READ
• REDBRICK_FILE_PERMISSION_OTHERS_WRITE
• REDBRICK_FILE_PERMISSION_OTHERS_EXECUTE

pub fn read_file(
    &self,
    file_id: u16,
    length_to_read: u8
) -> ConvertingReceiver<ReadFile>

Reads up to 62 bytes from a file object.

Returns the bytes read, the actual number of bytes read and the resulting error code.

If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are returned.

If the file object was created by Open File without the NonBlocking flag or by Create Pipe without the NonBlockingRead flag then the error code NotSupported is returned.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn read_file_async(
    &self,
    file_id: u16,
    length_to_read: u64
) -> ConvertingReceiver<()>

Reads up to 2\ :sup:63\ - 1 bytes from a file object asynchronously.

Reports the bytes read (in 60 byte chunks), the actual number of bytes read and the resulting error code via the get_async_file_read_callback_receiver receiver.

If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are reported.

If the file object was created by Open File without the NonBlocking flag or by Create Pipe without the NonBlockingRead flag then the error code NotSupported is reported via the get_async_file_read_callback_receiver receiver.

pub fn abort_async_file_read(&self, file_id: u16) -> ConvertingReceiver<u8>

Aborts a Read File Async operation in progress.

Returns the resulting error code.

On success the get_async_file_read_callback_receiver receiver will report OperationAborted.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn write_file(
    &self,
    file_id: u16,
    buffer: [u8; 61],
    length_to_write: u8
) -> ConvertingReceiver<WriteFile>

Writes up to 61 bytes to a file object.

Returns the actual number of bytes written and the resulting error code.

If the file object was created by Open File without the NonBlocking flag or by Create Pipe without the NonBlockingWrite flag then the error code NotSupported is returned.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn write_file_unchecked(
    &self,
    file_id: u16,
    buffer: [u8; 61],
    length_to_write: u8
) -> ConvertingReceiver<()>

Writes up to 61 bytes to a file object.

Does neither report the actual number of bytes written nor the resulting error code.

If the file object was created by Open File without the NonBlocking flag or by Create Pipe without the NonBlockingWrite flag then the write operation will fail silently.

pub fn write_file_async(
    &self,
    file_id: u16,
    buffer: [u8; 61],
    length_to_write: u8
) -> ConvertingReceiver<()>

Writes up to 61 bytes to a file object.

Reports the actual number of bytes written and the resulting error code via the get_async_file_write_callback_receiver receiver.

If the file object was created by Open File without the NonBlocking flag or by Create Pipe without the NonBlockingWrite flag then the error code NotSupported is reported via the get_async_file_write_callback_receiver receiver.

pub fn set_file_position(
    &self,
    file_id: u16,
    offset: i64,
    origin: u8
) -> ConvertingReceiver<SetFilePosition>

Set the current seek position of a file object in bytes relative to origin.

Possible file origins are:

• Beginning = 0
• Current = 1
• End = 2

Returns the resulting absolute seek position and error code.

If the file object was created by Create Pipe then it has no seek position and the error code InvalidSeek is returned.

Associated constants:

• REDBRICK_FILE_ORIGIN_BEGINNING
• REDBRICK_FILE_ORIGIN_CURRENT
• REDBRICK_FILE_ORIGIN_END
• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_file_position(&self, file_id: u16) -> ConvertingReceiver<FilePosition>

Returns the current seek position of a file object in bytes and returns the resulting error code.

If the file object was created by Create Pipe then it has no seek position and the error code InvalidSeek is returned.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn set_file_events(&self, file_id: u16, events: u16) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_FILE_EVENT_READABLE
• REDBRICK_FILE_EVENT_WRITABLE
• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_file_events(&self, file_id: u16) -> ConvertingReceiver<FileEvents>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES
• REDBRICK_FILE_EVENT_READABLE
• REDBRICK_FILE_EVENT_WRITABLE

pub fn open_directory(
    &self,
    name_string_id: u16,
    session_id: u16
) -> ConvertingReceiver<OpenDirectory>

Opens an existing directory and allocates a new directory object for it.

FIXME: name has to be absolute

The reference count of the name string object is increased by one. When the directory object is destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the directory object holds a reference to it.

Returns the object ID of the new directory object and the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_directory_name(
    &self,
    directory_id: u16,
    session_id: u16
) -> ConvertingReceiver<DirectoryName>

Returns the name of a directory object, as passed to Open Directory, and the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_next_directory_entry(
    &self,
    directory_id: u16,
    session_id: u16
) -> ConvertingReceiver<NextDirectoryEntry>

Returns the next entry in a directory object and the resulting error code.

If there is not next entry then error code NoMoreData is returned. To rewind a directory object call Rewind Directory.

Possible directory entry types are:

• Unknown = 0
• Regular = 1
• Directory = 2
• Character = 3
• Block = 4
• FIFO = 5
• Symlink = 6
• Socket = 7

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES
• REDBRICK_DIRECTORY_ENTRY_TYPE_UNKNOWN
• REDBRICK_DIRECTORY_ENTRY_TYPE_REGULAR
• REDBRICK_DIRECTORY_ENTRY_TYPE_DIRECTORY
• REDBRICK_DIRECTORY_ENTRY_TYPE_CHARACTER
• REDBRICK_DIRECTORY_ENTRY_TYPE_BLOCK
• REDBRICK_DIRECTORY_ENTRY_TYPE_FIFO
• REDBRICK_DIRECTORY_ENTRY_TYPE_SYMLINK
• REDBRICK_DIRECTORY_ENTRY_TYPE_SOCKET

pub fn rewind_directory(&self, directory_id: u16) -> ConvertingReceiver<u8>

Rewinds a directory object and returns the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn create_directory(
    &self,
    name_string_id: u16,
    flags: u32,
    permissions: u16,
    uid: u32,
    gid: u32
) -> ConvertingReceiver<u8>

FIXME: name has to be absolute

Associated constants:

• REDBRICK_DIRECTORY_FLAG_RECURSIVE
• REDBRICK_DIRECTORY_FLAG_EXCLUSIVE
• REDBRICK_FILE_PERMISSION_USER_ALL
• REDBRICK_FILE_PERMISSION_USER_READ
• REDBRICK_FILE_PERMISSION_USER_WRITE
• REDBRICK_FILE_PERMISSION_USER_EXECUTE
• REDBRICK_FILE_PERMISSION_GROUP_ALL
• REDBRICK_FILE_PERMISSION_GROUP_READ
• REDBRICK_FILE_PERMISSION_GROUP_WRITE
• REDBRICK_FILE_PERMISSION_GROUP_EXECUTE
• REDBRICK_FILE_PERMISSION_OTHERS_ALL
• REDBRICK_FILE_PERMISSION_OTHERS_READ
• REDBRICK_FILE_PERMISSION_OTHERS_WRITE
• REDBRICK_FILE_PERMISSION_OTHERS_EXECUTE
• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_processes(&self, session_id: u16) -> ConvertingReceiver<Processes>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn spawn_process(
    &self,
    executable_string_id: u16,
    arguments_list_id: u16,
    environment_list_id: u16,
    working_directory_string_id: u16,
    uid: u32,
    gid: u32,
    stdin_file_id: u16,
    stdout_file_id: u16,
    stderr_file_id: u16,
    session_id: u16
) -> ConvertingReceiver<SpawnProcess>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn kill_process(&self, process_id: u16, signal: u8) -> ConvertingReceiver<u8>

Sends a UNIX signal to a process object and returns the resulting error code.

Possible UNIX signals are:

• Interrupt = 2
• Quit = 3
• Abort = 6
• Kill = 9
• User1 = 10
• User2 = 12
• Terminate = 15
• Continue = 18
• Stop = 19

Associated constants:

• REDBRICK_PROCESS_SIGNAL_INTERRUPT
• REDBRICK_PROCESS_SIGNAL_QUIT
• REDBRICK_PROCESS_SIGNAL_ABORT
• REDBRICK_PROCESS_SIGNAL_KILL
• REDBRICK_PROCESS_SIGNAL_USER1
• REDBRICK_PROCESS_SIGNAL_USER2
• REDBRICK_PROCESS_SIGNAL_TERMINATE
• REDBRICK_PROCESS_SIGNAL_CONTINUE
• REDBRICK_PROCESS_SIGNAL_STOP
• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_process_command(
    &self,
    process_id: u16,
    session_id: u16
) -> ConvertingReceiver<ProcessCommand>

Returns the executable, arguments, environment and working directory used to spawn a process object, as passed to Spawn Process, and the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_process_identity(
    &self,
    process_id: u16
) -> ConvertingReceiver<ProcessIdentity>

Returns the process ID and the user and group ID used to spawn a process object, as passed to Spawn Process, and the resulting error code.

The process ID is only valid if the state is Running or Stopped, see Get Process State.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_process_stdio(
    &self,
    process_id: u16,
    session_id: u16
) -> ConvertingReceiver<ProcessStdio>

Returns the stdin, stdout and stderr files used to spawn a process object, as passed to Spawn Process, and the resulting error code.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_process_state(
    &self,
    process_id: u16
) -> ConvertingReceiver<ProcessState>

Returns the current state, timestamp and exit code of a process object, and the resulting error code.

Possible process states are:

• Unknown = 0
• Running = 1
• Error = 2
• Exited = 3
• Killed = 4
• Stopped = 5

The timestamp represents the UNIX time since when the process is in its current state.

The exit code is only valid if the state is Error, Exited, Killed or Stopped and has different meanings depending on the state:

• Error: error code for error occurred while spawning the process (see below)
• Exited: exit status of the process
• Killed: UNIX signal number used to kill the process
• Stopped: UNIX signal number used to stop the process

Possible exit/error codes in Error state are:

• InternalError = 125
• CannotExecute = 126
• DoesNotExist = 127

The CannotExecute error can be caused by the executable being opened for writing.

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES
• REDBRICK_PROCESS_STATE_UNKNOWN
• REDBRICK_PROCESS_STATE_RUNNING
• REDBRICK_PROCESS_STATE_ERROR
• REDBRICK_PROCESS_STATE_EXITED
• REDBRICK_PROCESS_STATE_KILLED
• REDBRICK_PROCESS_STATE_STOPPED

pub fn get_programs(&self, session_id: u16) -> ConvertingReceiver<Programs>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn define_program(
    &self,
    identifier_string_id: u16,
    session_id: u16
) -> ConvertingReceiver<DefineProgram>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn purge_program(
    &self,
    program_id: u16,
    cookie: u32
) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_program_identifier(
    &self,
    program_id: u16,
    session_id: u16
) -> ConvertingReceiver<ProgramIdentifier>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_program_root_directory(
    &self,
    program_id: u16,
    session_id: u16
) -> ConvertingReceiver<ProgramRootDirectory>

FIXME: root directory is absolute: /programs/

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn set_program_command(
    &self,
    program_id: u16,
    executable_string_id: u16,
    arguments_list_id: u16,
    environment_list_id: u16,
    working_directory_string_id: u16
) -> ConvertingReceiver<u8>

FIXME: working directory is relative to /programs//bin

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_program_command(
    &self,
    program_id: u16,
    session_id: u16
) -> ConvertingReceiver<ProgramCommand>

FIXME: working directory is relative to /programs//bin

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn set_program_stdio_redirection(
    &self,
    program_id: u16,
    stdin_redirection: u8,
    stdin_file_name_string_id: u16,
    stdout_redirection: u8,
    stdout_file_name_string_id: u16,
    stderr_redirection: u8,
    stderr_file_name_string_id: u16
) -> ConvertingReceiver<u8>

FIXME: stdio file names are relative to /programs//bin

Associated constants:

• REDBRICK_PROGRAM_STDIO_REDIRECTION_DEV_NULL
• REDBRICK_PROGRAM_STDIO_REDIRECTION_PIPE
• REDBRICK_PROGRAM_STDIO_REDIRECTION_FILE
• REDBRICK_PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG
• REDBRICK_PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG
• REDBRICK_PROGRAM_STDIO_REDIRECTION_STDOUT
• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_program_stdio_redirection(
    &self,
    program_id: u16,
    session_id: u16
) -> ConvertingReceiver<ProgramStdioRedirection>

FIXME: stdio file names are relative to /programs//bin

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES
• REDBRICK_PROGRAM_STDIO_REDIRECTION_DEV_NULL
• REDBRICK_PROGRAM_STDIO_REDIRECTION_PIPE
• REDBRICK_PROGRAM_STDIO_REDIRECTION_FILE
• REDBRICK_PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG
• REDBRICK_PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG
• REDBRICK_PROGRAM_STDIO_REDIRECTION_STDOUT

pub fn set_program_schedule(
    &self,
    program_id: u16,
    start_mode: u8,
    continue_after_error: bool,
    start_interval: u32,
    start_fields_string_id: u16
) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_PROGRAM_START_MODE_NEVER
• REDBRICK_PROGRAM_START_MODE_ALWAYS
• REDBRICK_PROGRAM_START_MODE_INTERVAL
• REDBRICK_PROGRAM_START_MODE_CRON
• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_program_schedule(
    &self,
    program_id: u16,
    session_id: u16
) -> ConvertingReceiver<ProgramSchedule>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES
• REDBRICK_PROGRAM_START_MODE_NEVER
• REDBRICK_PROGRAM_START_MODE_ALWAYS
• REDBRICK_PROGRAM_START_MODE_INTERVAL
• REDBRICK_PROGRAM_START_MODE_CRON

pub fn get_program_scheduler_state(
    &self,
    program_id: u16,
    session_id: u16
) -> ConvertingReceiver<ProgramSchedulerState>

FIXME: message is currently valid in error-occurred state only

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES
• REDBRICK_PROGRAM_SCHEDULER_STATE_STOPPED
• REDBRICK_PROGRAM_SCHEDULER_STATE_RUNNING

pub fn continue_program_schedule(
    &self,
    program_id: u16
) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn start_program(&self, program_id: u16) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_last_spawned_program_process(
    &self,
    program_id: u16,
    session_id: u16
) -> ConvertingReceiver<LastSpawnedProgramProcess>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_custom_program_option_names(
    &self,
    program_id: u16,
    session_id: u16
) -> ConvertingReceiver<CustomProgramOptionNames>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn set_custom_program_option_value(
    &self,
    program_id: u16,
    name_string_id: u16,
    value_string_id: u16
) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_custom_program_option_value(
    &self,
    program_id: u16,
    name_string_id: u16,
    session_id: u16
) -> ConvertingReceiver<CustomProgramOptionValue>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn remove_custom_program_option(
    &self,
    program_id: u16,
    name_string_id: u16
) -> ConvertingReceiver<u8>

Associated constants:

• REDBRICK_ERROR_CODE_SUCCESS
• REDBRICK_ERROR_CODE_UNKNOWN_ERROR
• REDBRICK_ERROR_CODE_INVALID_OPERATION
• REDBRICK_ERROR_CODE_OPERATION_ABORTED
• REDBRICK_ERROR_CODE_INTERNAL_ERROR
• REDBRICK_ERROR_CODE_UNKNOWN_SESSION_ID
• REDBRICK_ERROR_CODE_NO_FREE_SESSION_ID
• REDBRICK_ERROR_CODE_UNKNOWN_OBJECT_ID
• REDBRICK_ERROR_CODE_NO_FREE_OBJECT_ID
• REDBRICK_ERROR_CODE_OBJECT_IS_LOCKED
• REDBRICK_ERROR_CODE_NO_MORE_DATA
• REDBRICK_ERROR_CODE_WRONG_LIST_ITEM_TYPE
• REDBRICK_ERROR_CODE_PROGRAM_IS_PURGED
• REDBRICK_ERROR_CODE_INVALID_PARAMETER
• REDBRICK_ERROR_CODE_NO_FREE_MEMORY
• REDBRICK_ERROR_CODE_NO_FREE_SPACE
• REDBRICK_ERROR_CODE_ACCESS_DENIED
• REDBRICK_ERROR_CODE_ALREADY_EXISTS
• REDBRICK_ERROR_CODE_DOES_NOT_EXIST
• REDBRICK_ERROR_CODE_INTERRUPTED
• REDBRICK_ERROR_CODE_IS_DIRECTORY
• REDBRICK_ERROR_CODE_NOT_A_DIRECTORY
• REDBRICK_ERROR_CODE_WOULD_BLOCK
• REDBRICK_ERROR_CODE_OVERFLOW
• REDBRICK_ERROR_CODE_BAD_FILE_DESCRIPTOR
• REDBRICK_ERROR_CODE_OUT_OF_RANGE
• REDBRICK_ERROR_CODE_NAME_TOO_LONG
• REDBRICK_ERROR_CODE_INVALID_SEEK
• REDBRICK_ERROR_CODE_NOT_SUPPORTED
• REDBRICK_ERROR_CODE_TOO_MANY_OPEN_FILES

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be ‘0’-‘8’ (stack position).

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations

impl Clone for RedBrick

fn clone(&self) -> RedBrick

Returns a copy of the value.

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

Performs copy-assignment from source.