irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

irods::experimental::filesystem Namespace Reference

Namespaces

 client
 
 detail
 
 path_traits
 

Classes

struct  checksum
 
class  collection_entry
 
struct  entity_permission
 
class  filesystem_error
 
struct  metadata
 
class  object_status
 
class  path
 

Typedefs

using object_time_type = std::chrono::time_point< std::chrono::system_clock, std::chrono::seconds >
 

Enumerations

enum  copy_options {
  copy_options::none = 0, copy_options::skip_existing = 1 << 0, copy_options::overwrite_existing = 1 << 1, copy_options::update_existing = 1 << 2,
  copy_options::recursive = 1 << 3, copy_options::collections_only = 1 << 4, copy_options::in_recursive_copy = 1 << 5
}
 
enum  remove_options { remove_options::none, remove_options::no_trash }
 
enum  replica_number { replica_number::all }
 
enum  verification_calculation { verification_calculation::none, verification_calculation::if_empty, verification_calculation::always }
 
enum  object_type {
  object_type::none, object_type::not_found, object_type::data_object, object_type::collection,
  object_type::special_collection, object_type::unknown
}
 
enum  perms {
  perms::null, perms::read, perms::write, perms::own,
  perms::inherit, perms::noinherit
}
 

Functions

auto operator|= (copy_options &_lhs, copy_options _rhs) noexcept -> copy_options &
 
auto operator| (copy_options _lhs, copy_options _rhs) noexcept -> copy_options
 
auto operator&= (copy_options &_lhs, copy_options _rhs) noexcept -> copy_options &
 
auto operator& (copy_options _lhs, copy_options _rhs) noexcept -> copy_options
 
auto operator^= (copy_options &_lhs, copy_options _rhs) noexcept -> copy_options &
 
auto operator^ (copy_options _lhs, copy_options _rhs) noexcept -> copy_options
 
auto operator~ (copy_options &_value) noexcept -> copy_options &
 
auto lexicographical_compare (path::iterator _first1, path::iterator _last1, path::iterator _first2, path::iterator _last2) -> bool
 
auto operator== (const path &_lhs, const path &_rhs) noexcept -> bool
 
auto operator!= (const path &_lhs, const path &_rhs) noexcept -> bool
 
auto operator< (const path &_lhs, const path &_rhs) noexcept -> bool
 
auto operator<= (const path &_lhs, const path &_rhs) noexcept -> bool
 
auto operator> (const path &_lhs, const path &_rhs) noexcept -> bool
 
auto operator>= (const path &_lhs, const path &_rhs) noexcept -> bool
 
auto operator/ (const path &_lhs, const path &_rhs) -> path
 
auto operator<< (std::ostream &_os, const path &_p) -> std::ostream &
 
auto operator>> (std::istream &_is, path &_p) -> std::istream &
 
auto swap (path &_lhs, path &_rhs) noexcept -> void
 
auto hash_value (const path &_p) noexcept -> std::size_t
 

Typedef Documentation

◆ object_time_type

using irods::experimental::filesystem::object_time_type = typedef std::chrono::time_point<std::chrono::system_clock, std::chrono::seconds>

Definition at line 34 of file filesystem.hpp.

Enumeration Type Documentation

◆ copy_options

Enumerator
none 
skip_existing 
overwrite_existing 
update_existing 
recursive 
collections_only 
in_recursive_copy 

Definition at line 9 of file copy_options.hpp.

◆ object_type

Enumerator
none 
not_found 
data_object 
collection 
special_collection 
unknown 

Definition at line 11 of file object_status.hpp.

◆ perms

Enumerator
null 
read 
write 
own 
inherit 
noinherit 

Definition at line 8 of file permissions.hpp.

◆ remove_options

Enumerator
none 
no_trash 

Definition at line 36 of file filesystem.hpp.

◆ replica_number

Enumerator
all 

Definition at line 50 of file filesystem.hpp.

◆ verification_calculation

Enumerator
none 
if_empty 
always 

Definition at line 55 of file filesystem.hpp.

Function Documentation

◆ hash_value()

auto irods::experimental::filesystem::hash_value ( const path _p) -> std::size_t
noexcept

Definition at line 460 of file path.cpp.

References irods::experimental::filesystem::client::begin(), and irods::experimental::filesystem::client::end().

Here is the call graph for this function:

◆ lexicographical_compare()

auto irods::experimental::filesystem::lexicographical_compare ( path::iterator  _first1,
path::iterator  _last1,
path::iterator  _first2,
path::iterator  _last2 
) -> bool

Definition at line 431 of file path.cpp.

◆ operator!=()

auto irods::experimental::filesystem::operator!= ( const path _lhs,
const path _rhs 
) -> bool
inlinenoexcept

Definition at line 370 of file path.hpp.

◆ operator&()

auto irods::experimental::filesystem::operator& ( copy_options  _lhs,
copy_options  _rhs 
) -> copy_options
inlinenoexcept

Definition at line 37 of file copy_options.hpp.

◆ operator&=()

auto irods::experimental::filesystem::operator&= ( copy_options _lhs,
copy_options  _rhs 
) -> copy_options&
inlinenoexcept

Definition at line 31 of file copy_options.hpp.

◆ operator/()

auto irods::experimental::filesystem::operator/ ( const path _lhs,
const path _rhs 
) -> path
inline

Definition at line 376 of file path.hpp.

◆ operator<()

auto irods::experimental::filesystem::operator< ( const path _lhs,
const path _rhs 
) -> bool
inlinenoexcept

Definition at line 371 of file path.hpp.

◆ operator<<()

auto irods::experimental::filesystem::operator<< ( std::ostream &  _os,
const path _p 
) -> std::ostream&

Definition at line 447 of file path.cpp.

◆ operator<=()

auto irods::experimental::filesystem::operator<= ( const path _lhs,
const path _rhs 
) -> bool
inlinenoexcept

Definition at line 372 of file path.hpp.

◆ operator==()

auto irods::experimental::filesystem::operator== ( const path _lhs,
const path _rhs 
) -> bool
inlinenoexcept

Definition at line 369 of file path.hpp.

◆ operator>()

auto irods::experimental::filesystem::operator> ( const path _lhs,
const path _rhs 
) -> bool
inlinenoexcept

Definition at line 373 of file path.hpp.

◆ operator>=()

auto irods::experimental::filesystem::operator>= ( const path _lhs,
const path _rhs 
) -> bool
inlinenoexcept

Definition at line 374 of file path.hpp.

◆ operator>>()

auto irods::experimental::filesystem::operator>> ( std::istream &  _is,
path _p 
) -> std::istream&

Definition at line 452 of file path.cpp.

◆ operator^()

auto irods::experimental::filesystem::operator^ ( copy_options  _lhs,
copy_options  _rhs 
) -> copy_options
inlinenoexcept

Definition at line 48 of file copy_options.hpp.

◆ operator^=()

auto irods::experimental::filesystem::operator^= ( copy_options _lhs,
copy_options  _rhs 
) -> copy_options&
inlinenoexcept

Definition at line 42 of file copy_options.hpp.

◆ operator|()

auto irods::experimental::filesystem::operator| ( copy_options  _lhs,
copy_options  _rhs 
) -> copy_options
inlinenoexcept

Definition at line 26 of file copy_options.hpp.

◆ operator|=()

auto irods::experimental::filesystem::operator|= ( copy_options _lhs,
copy_options  _rhs 
) -> copy_options&
inlinenoexcept

Definition at line 20 of file copy_options.hpp.

◆ operator~()

auto irods::experimental::filesystem::operator~ ( copy_options _value) -> copy_options&
inlinenoexcept

Definition at line 53 of file copy_options.hpp.

◆ swap()

auto irods::experimental::filesystem::swap ( path _lhs,
path _rhs 
) -> void
inlinenoexcept