Struct File 

pub struct File<S: FileSubtype = GenericFile> { /* private fields */ }

A file parameter schema for file uploads and references.

File parameters support various file types through FileSubtype, with MIME type filtering and size constraints. This is the schema definition - it does not hold runtime values.

Value Representation

File produces Value::Object with standard fields:

{
    "id": "file-abc123",
    "name": "document.pdf",
    "size": 102400,
    "mime": "application/pdf",
    "url": "https://..."
}

Example

use paramdef::types::leaf::File;
use paramdef::subtype::{Image, Pdf};

// Generic file upload
let attachment = File::builder("attachment")
    .label("Attachment")
    .build();

// Image upload with size limit
let avatar = File::image("avatar")
    .max_size_mb(5)
    .required()
    .build();

// PDF document
let document = File::pdf("contract")
    .label("Contract PDF")
    .required()
    .build();

Implementations

impl<S: FileSubtype> File<S>

pub fn subtype(&self) -> &S

Returns the file subtype.

pub fn accept(&self) -> Vec<&str>

Returns the accepted MIME types.

Combines subtype’s accept list with any additional types.

pub fn max_size(&self) -> Option<u64>

Returns the maximum file size in bytes.

Returns the explicit max_size if set, otherwise the subtype’s default.

pub fn is_multiple(&self) -> bool

Returns whether multiple files are allowed.

pub fn flags(&self) -> Flags

Returns the flags.

impl File<GenericFile>

pub fn builder(key: impl Into<Key>) -> FileBuilder<GenericFile>

Creates a new builder for a generic file parameter.

impl File<Image>

pub fn image(key: impl Into<Key>) -> FileBuilder<Image>

Creates an image file parameter builder.

impl File<Photo>

pub fn photo(key: impl Into<Key>) -> FileBuilder<Photo>

Creates a photo file parameter builder.

impl File<Avatar>

pub fn avatar(key: impl Into<Key>) -> FileBuilder<Avatar>

Creates an avatar file parameter builder.

impl File<Pdf>

pub fn pdf(key: impl Into<Key>) -> FileBuilder<Pdf>

Creates a PDF file parameter builder.

impl File<Document>

pub fn document(key: impl Into<Key>) -> FileBuilder<Document>

Creates a document file parameter builder.

impl File<Video>

pub fn video(key: impl Into<Key>) -> FileBuilder<Video>

Creates a video file parameter builder.

impl File<Audio>

pub fn audio(key: impl Into<Key>) -> FileBuilder<Audio>

Creates an audio file parameter builder.

impl File<Archive>

pub fn archive(key: impl Into<Key>) -> FileBuilder<Archive>

Creates an archive file parameter builder.

impl File<Signature>

pub fn signature(key: impl Into<Key>) -> FileBuilder<Signature>

Creates a signature file parameter builder.

Trait Implementations

impl<S: Clone + FileSubtype> Clone for File<S>

fn clone(&self) -> File<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + FileSubtype> Debug for File<S>

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

Formats the value using the given formatter.

impl<S: FileSubtype> Leaf for File<S>

fn default_value(&self) -> Option<Value>

Returns the default value for this parameter, if set.

impl<S: FileSubtype + 'static> Node for File<S>

fn metadata(&self) -> &Metadata

Returns the node’s metadata.

fn key(&self) -> &Key

Returns the node’s unique key.

fn kind(&self) -> NodeKind

Returns the node’s kind (category).

fn as_any(&self) -> &dyn Any

Returns a reference to the underlying type for downcasting.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns a mutable reference to the underlying type for downcasting.