Module iceoryx2_bb_system_types::file_name

Relocatable (inter-process shared memory compatible) semantic_string::SemanticString implementation for FileName. All modification operations ensure that never an invalid file or path name can be generated. All strings have a fixed size so that the maximum path or file name length the system supports can be stored.

Example

use iceoryx2_bb_container::semantic_string::SemanticString;
use iceoryx2_bb_system_types::file_name::*;

let name = FileName::new(b"some_file.txt");

let invalid_name = FileName::new(b"no/path/allowed.txt");
assert!(invalid_name.is_err());

Structs

• FileName
  Represents a file name. The restriction are choosen in a way that it is platform independent. This means characters/strings which would be legal on some platforms are forbidden as well.

Traits

• SemanticString
  Trait that defines the methods a FixedSizeByteString with context semantics, a SemanticString shares. A new SemanticString can be created with the crate::semantic_string! macro. For the usage, see crate::semantic_string.