Struct FileNameIsOwned

pub struct FileNameIsOwned<const OWNED: bool>(/* private fields */);

wxFileName encapsulates a file name.

• FileName represents a C++ wxFileName class instance which your code has ownership, FileNameIsOwned<false> represents one which don’t own.
• Use FileName’s new() to create an instance of this class.
• See C++ wxFileName class’s documentation for more details.

Implementations

impl<const OWNED: bool> FileNameIsOwned<OWNED>

pub fn new() -> FileNameIsOwned<OWNED>

Default constructor.

See C++ wxFileName::wxFileName()’s documentation.

pub fn new_with_filename<F: FileNameMethods>( filename: &F, ) -> FileNameIsOwned<OWNED>

Copy constructor.

See C++ wxFileName::wxFileName()’s documentation.

pub fn none() -> Option<&'static Self>

Trait Implementations

impl Clone for FileNameIsOwned<false>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const OWNED: bool> Drop for FileNameIsOwned<OWNED>

fn drop(&mut self)

Executes the destructor for this type.

impl<const OWNED: bool> FileNameMethods for FileNameIsOwned<OWNED>

fn append_dir(&self, dir: &str) -> bool

Appends a directory component to the path.

fn assign<F: FileNameMethods>(&self, filepath: &F)

Creates the file name from another filename object.

fn assign_cwd(&self, volume: &str)

Makes this object refer to the current working directory on the specified volume (or current volume if volume is empty).

fn assign_home_dir(&self)

Sets this file name object to the home directory.

fn assign_temp_file_name(&self, prefix: &str)

The function calls CreateTempFileName() to create a temporary file and sets this object to the name of the file.

fn assign_temp_file_name_file(&self, prefix: &str, file_temp: *mut c_void)

The function calls CreateTempFileName() to create a temporary file name and open fileTemp with it.

fn assign_temp_file_name_ffile(&self, prefix: &str, file_temp: *mut c_void)

The function calls CreateTempFileName() to create a temporary file name and open fileTemp with it.

fn clear(&self)

Reset all components to default, uninitialized state.

fn clear_ext(&self)

Removes the extension from the file name resulting in a file name with no trailing dot.

fn dir_exists(&self) -> bool

Returns true if the directory with this name exists.

fn dont_follow_link(&self)

Turns off symlink dereferencing.

fn exists_int(&self, flags: c_int) -> bool

Calls the static overload of this function with the full path of this object.

fn file_exists(&self) -> bool

Returns true if the file with this name exists.

fn get_dir_count(&self) -> usize

Returns the number of directories in the file name.

fn get_dirs(&self) -> ArrayStringIsOwned<false>

Returns the directories in string array form.

fn get_ext(&self) -> String

Returns the file name extension.

fn get_full_name(&self) -> String

Returns the full name (including extension but excluding directories).

fn get_long_path(&self) -> String

Return the long form of the path (returns identity on non-Windows platforms).

fn get_modification_time(&self) -> DateTime

Returns the last time the file was last modified.

fn get_name(&self) -> String

Returns the name part of the filename (without extension).

fn get_short_path(&self) -> String

Return the short form of the path (returns identity on non-Windows platforms).

fn get_times<D: DateTimeMethods, D2: DateTimeMethods, D3: DateTimeMethods>( &self, dt_access: Option<&D>, dt_mod: Option<&D2>, dt_create: Option<&D3>, ) -> bool

Returns the last access, last modification and creation times.

fn get_volume(&self) -> String

Returns the string containing the volume for this file name.

fn has_ext(&self) -> bool

Returns true if an extension is present.

fn has_name(&self) -> bool

Returns true if a name is present.

fn has_volume(&self) -> bool

Returns true if a volume specifier is present.

fn insert_dir(&self, before: usize, dir: &str) -> bool

Inserts a directory component before the zero-based position in the directory list.

fn is_dir(&self) -> bool

Returns true if this object represents a directory, false otherwise (i.e.

fn is_dir_readable(&self) -> bool

Returns true if the directory component of this instance is an existing directory and this process has read permissions on it.

fn is_dir_writable(&self) -> bool

Returns true if the directory component of this instance is an existing directory and this process has write permissions on it.

fn is_file_executable(&self) -> bool

Returns true if a file with this name exists and if this process has execute permissions on it.

fn is_file_readable(&self) -> bool

Returns true if a file with this name exists and if this process has read permissions on it.

fn is_file_writable(&self) -> bool

Returns true if a file with this name exists and if this process has write permissions on it.

fn is_ok(&self) -> bool

Returns true if the filename is valid, false if it is not initialized yet.

fn mkdir_int(&self, perm: c_int, flags: c_int) -> bool

Creates a directory.

fn prepend_dir(&self, dir: &str)

Prepends a directory to the file path.

fn remove_dir(&self, pos: usize)

Removes the specified directory component from the path.

fn remove_last_dir(&self)

Removes last directory component from the path.

fn resolve_link(&self) -> FileName

Find the absolute path of the file/directory that is pointed to by this path.

fn rmdir_int(&self, flags: c_int) -> bool

Deletes the specified directory from the file system.

fn set_cwd(&self) -> bool

Changes the current working directory.

fn set_empty_ext(&self)

Sets the extension of the file name to be an empty extension.

fn set_ext(&self, ext: &str)

Sets the extension of the file name.

fn set_full_name(&self, fullname: &str)

The full name is the file name and extension (but without the path).

fn set_name(&self, name: &str)

Sets the name part (without extension).

fn set_permissions(&self, permissions: c_int) -> bool

Sets permissions for this file or directory.

fn set_times<D: DateTimeMethods, D2: DateTimeMethods, D3: DateTimeMethods>( &self, dt_access: Option<&D>, dt_mod: Option<&D2>, dt_create: Option<&D3>, ) -> bool

Sets the file creation and last access/modification times (any of the pointers may be NULL).

fn set_volume(&self, volume: &str)

Sets the volume specifier.

fn should_follow_link(&self) -> bool

Return whether some operations will follow symlink.

fn touch(&self) -> bool

Sets the access and modification times to the current moment.

fn create_temp_file_name_file(prefix: &str, file_temp: *mut c_void) -> String

Returns a temporary file name starting with the given prefix.

fn create_temp_file_name_ffile(prefix: &str, file_temp: *mut c_void) -> String

This is the same as CreateTempFileName(const wxString &prefix, wxFile *fileTemp) but takes a wxFFile parameter instead of wxFile.

fn dir_exists_str(dir: &str) -> bool

Returns true if the directory with name dir exists.

fn exists_str(path: &str, flags: c_int) -> bool

Returns true if either a file or a directory or something else with this name exists in the file system.

fn file_exists_str(file: &str) -> bool

Returns true if the file with name file exists.

fn get_cwd(volume: &str) -> String

Retrieves the value of the current working directory on the specified volume.

fn get_home_dir() -> String

Returns the home directory.

fn get_temp_dir() -> String

Returns the directory used for temporary files, for current user.

fn is_dir_readable_str(dir: &str) -> bool

Returns true if the given dir is an existing directory and this process has read permissions on it.

fn is_dir_writable_str(dir: &str) -> bool

Returns true if the given dir is an existing directory and this process has write permissions on it.

fn is_file_executable_str(file: &str) -> bool

Returns true if a file with this name exists and if this process has execute permissions on it.

fn is_file_readable_str(file: &str) -> bool

Returns true if a file with this name exists and if this process has read permissions on it.

fn is_file_writable_str(file: &str) -> bool

Returns true if a file with this name exists and if this process has write permissions on it.

fn mkdir_str(dir: &str, perm: c_int, flags: c_int) -> bool

Creates a directory.

fn rmdir_str(dir: &str, flags: c_int) -> bool

Deletes the specified directory from the file system.

fn set_cwd_str(cwd: &str) -> bool

Changes the current working directory.

fn url_to_file_name(url: &str) -> FileName

Converts URL into a well-formed filename.

fn file_name_to_url<F: FileNameMethods>(filename: &F) -> String

Converts wxFileName into an URL.

fn strip_extension(fullname: &str) -> String

Strip the file extension.

impl<const OWNED: bool> WxRustMethods for FileNameIsOwned<OWNED>

type Unowned = FileNameIsOwned<false>

unsafe fn as_ptr(&self) -> *mut c_void

unsafe fn from_ptr(ptr: *mut c_void) -> Self

unsafe fn from_unowned_ptr(ptr: *mut c_void) -> Self::Unowned

unsafe fn with_ptr<F: Fn(&Self)>(ptr: *mut c_void, closure: F)

unsafe fn option_from(ptr: *mut c_void) -> Option<Self::Unowned>

where Self: Sized,