Struct FileInputConfig

pub struct FileInputConfig {
    pub path: String,
    pub buffer_size_bytes: Option<usize>,
    pub follow: bool,
}

Configuration for reading data from a file with FileInputTransport

Fields

path: String

File path.

buffer_size_bytes: Option<usize>

Read buffer size.

Default: when this parameter is not specified, a platform-specific default is used.

follow: bool

Enable file following.

When false, the endpoint outputs an InputConsumer::eoi message and stops upon reaching the end of file. When true, the endpoint will keep watching the file and outputting any new content appended to it.

Trait Implementations

impl Clone for FileInputConfig

fn clone(&self) -> FileInputConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileInputConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileInputConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FileInputConfig

fn eq(&self, other: &FileInputConfig) -> 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 Serialize for FileInputConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for FileInputConfig

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for FileInputConfig

impl StructuralPartialEq for FileInputConfig