Struct AppInfo

pub struct AppInfo {
    pub name: &'static str,
    pub author: &'static str,
}

Struct that holds information about your app.

It’s recommended to create a single const instance of AppInfo:

use app_dirs2::AppInfo;
const APP_INFO: AppInfo = AppInfo{name: "Awesome App", author: "Dedicated Dev"};

Caveats

Functions in this library sanitize any characters that could be non-filename-safe from name and author. The resulting paths will be more human-readable if you stick to letters, numbers, spaces, hyphens, underscores, and periods for both properties.

The author property is currently only used by Windows, as macOS and *nix specifications don’t require it. Make sure your name string is unique!

Fields

name: &'static str

Name of your app (e.g. “Hearthstone”).

author: &'static str

Author of your app (e.g. “Blizzard”).

Trait Implementations

impl Clone for AppInfo

fn clone(&self) -> AppInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppInfo

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

Formats the value using the given formatter.

impl Hash for AppInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AppInfo

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

Tests for self and other values to be equal, and is used by ==.

const 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 Eq for AppInfo

impl StructuralPartialEq for AppInfo