Struct FileExtension

pub struct FileExtension(/* private fields */);

The extension of a filename.

Can be parsed using std::str::FromStr. May contain alphanumeric ascii characters only, and is restricted to a length of FILE_EXTENSION_MAX_LENGTH characters. This is an arbitrary decision based on regular usage of filename extensions as seen commonly used. This serves as sanitization measure for user input.

Implementations

impl FileExtension

pub fn as_str(&self) -> &str

Extracts a string slice containing the file extension.

pub fn to_string_with_leading_dot(&self) -> String

Return the file extension including a leading dot.

This is useful for appending it to a file stem without having to care about placing the dot depending on whether the extension is empty.

let file_stem = "hello-world";
let file_extension: FileExtension = "abc".parse().unwrap();
let file_name = format!("{}{}", file_stem, file_extension.to_string_with_leading_dot());
assert_eq!(file_name.as_str(), "hello-world.abc");

let file_stem = "hello-world";
let file_extension: FileExtension = "".parse().unwrap();
let file_name = format!("{}{}", file_stem, file_extension.to_string_with_leading_dot());
assert_eq!(file_name.as_str(), "hello-world");

pub fn pdf() -> Self

Predefined extension for PDF files

Trait Implementations

impl Clone for FileExtension

fn clone(&self) -> FileExtension

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileExtension

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

Formats the value using the given formatter.

impl Default for FileExtension

fn default() -> FileExtension

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileExtension

where Self: FromStr, <Self as FromStr>::Err: Display,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FileExtension

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

Formats the value using the given formatter.

impl ExampleData for FileExtension

fn example_data() -> Self

Get an example instance of the current datatype.

impl FromStr for FileExtension

type Err = ParseFileExtensionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for FileExtension

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

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for FileExtension

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for FileExtension

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

fn name() -> Cow<'static, str>

Return name of the schema.

impl Eq for FileExtension

impl StructuralPartialEq for FileExtension