Module gix::path

Modules

• realpath

Structs

• Spec
  A dummy type to represent path specs and help finding all spots that take path specs once it is implemented. A preliminary version of a path-spec based on glances of the code.
• Utf8Error
  The error type returned by into_bstr() and others may suffer from failed conversions from or to bytes.

Functions

• env_var
  Returns the contents of an environment variable of name with some special handling for certain environment variables (like HOME) for platform compatibility.
• from_bstr
  Similar to try_from_bstr(), but panics if malformed surrogates are encountered on windows.
• from_bstring
  Similar to try_from_bstring(), but will panic if there is ill-formed UTF-8 in the input.
• from_byte_slice
  Similar to try_from_byte_slice(), but will panic if there is ill-formed UTF-8 in the input.
• home_dir
  Returns a platform independent home directory.
• into_bstr
  Similar to try_into_bstr() but panics if malformed surrogates are encountered on windows.
• is_absolute
  return true if path is absolute, which depends on the platform but is always true if it starts with a slash, hence looks like a linux path.
• normalize
  Resolve relative components virtually without accessing the file system, e.g. turn a/./b/c/.././.. into a, without keeping intermediate .. and /a/../b/.. becomes /. If the input path was relative and ends up being the current_dir, . is returned instead of the full path to current_dir.
• os_str_into_bstr
  Like into_bstr(), but takes OsStr as input for a lossless, but fallible, conversion.
• os_string_into_bstring
  Like into_bstr(), but takes OsString as input for a lossless, but fallible, conversion.
• realpath
  Check each component of path and see if it is a symlink. If so, resolve it. Do not fail for non-existing components, but assume these are as is.
• realpath_opts
  The same as realpath(), but allow to configure max_symlinks to configure how many symbolic links we are going to follow. This serves to avoid running into cycles or doing unreasonable amounts of work.
• to_native_path_on_windows
  Convert paths with slashes to backslashes on windows and do nothing on unix, but panics if malformed surrogates are encountered on windows.
• to_native_separators
  Assures the given bytes use the native path separator.
• to_unix_separators
  Replaces windows path separators with slashes, unconditionally.
• to_unix_separators_on_windows
  Replaces windows path separators with slashes, but only do so on windows.
• to_windows_separators
  Find backslashes and replace them with slashes, which typically resembles a unix path, unconditionally.
• try_from_bstr
  Similar to from_byte_slice(), but takes either borrowed or owned input.
• try_from_bstring
  Similar to try_from_bstr(), but takes and produces owned data.
• try_from_byte_slice
  Given input bytes, produce a Path from them ignoring encoding entirely if on unix.
• try_into_bstr
  Convert the given path either into its raw bytes on unix or its UTF8 encoded counterpart on windows.