Struct fiberplane_models::providers::FileField

#[non_exhaustive]
pub struct FileField {
    pub name: String,
    pub label: String,
    pub multiple: bool,
    pub required: bool,
}

Defines a field that allows files to be uploaded as part of the query data.

Query data that includes files will be encoded using “multipart/form-data”.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Name of the field as it will be included in the encoded query or config object.

label: String

Suggested label to display along the field.

multiple: bool

Whether multiple files may be uploaded.

required: bool

Whether a file is required.

Implementations

impl FileField

pub fn new() -> Self

Creates a new file field with all default values.

pub fn multiple(self) -> Self

Marks the field as allowing multiple files to be uploaded.

pub fn required(self) -> Self

Marks the field as required.

pub fn with_label(self, label: impl Into<String>) -> Self

pub fn with_name(self, name: impl Into<String>) -> Self

Trait Implementations

impl Clone for FileField

fn clone(&self) -> FileField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileField

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

Formats the value using the given formatter.

impl Default for FileField

fn default() -> FileField

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FileField> for QueryField

fn from(field: FileField) -> Self

Converts to this type from the input type.

impl PartialEq for FileField

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FileField

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileField