Struct canadensis_data_types::uavcan::file::list_0_1::ListRequest

pub struct ListRequest {
    pub entry_index: u32,
    pub directory_path: Path,
}

👎Deprecated

uavcan.file.List.0.1

Size ranges from 9 to 121 bytes

This service can be used to list a remote directory, one entry per request.

The client should query each entry independently, iterating ‘entry_index’ from 0 until the last entry. When the index reaches the number of elements in the directory, the server will report that there is no such entry by returning an empty name.

The field entry_index shall be applied to an ordered list of directory entries (e.g. alphabetically ordered). The exact sorting criteria does not matter as long as it provides the same ordering for subsequent service calls.

Observe that this listing operation is fundamentally non-atomic. The caller shall beware of possible race conditions and is responsible for handling them properly. Particularly, consider what happens if a new item is inserted into the directory between two subsequent calls: if the item happened to be inserted at the index that is lower than the index of the next request, the next returned item (or several, if more items were inserted) will repeat the ones that were listed earlier. The caller should handle that properly, either by ignoring the repeated items or by restarting the listing operation from the beginning (index 0).

Fields

entry_index: u32

👎Deprecated

saturated uint32

Always aligned, size 32 bits

directory_path: Path

👎Deprecated

uavcan.file.Path.1.0

Always aligned, size ranges from 8 to 904 bits

Trait Implementations

impl DataType for ListRequest

const EXTENT_BYTES: Option<u32> = _

This type is delimited with an extent of 300 bytes.

impl Deserialize for ListRequest

fn deserialize(cursor: &mut ReadCursor<'_>) -> Result<Self, DeserializeError>where Self: Sized,

Deserializes a value and returns it

fn deserialize_from_bytes(bytes: &[u8]) -> Result<Self, DeserializeError>where Self: Sized,

A convenience function that creates a cursor around the provided bytes and calls deserialize

impl Serialize for ListRequest

fn size_bits(&self) -> usize

Returns the size of the encoded form of this value, in bits

fn serialize(&self, cursor: &mut WriteCursor<'_>)

Serializes this value into a buffer

fn serialize_to_bytes(&self, bytes: &mut [u8])

A convenience function that creates a cursor around the provided bytes and calls serialize

impl Request for ListRequest