Filesystem Deprecated Features

| Filesystem Deprecated Features

Filesystem Home Releases Reference Tutorial FAQ Portability V3 Intro V3 Design Deprecated

## Deprecated names and features

As the library evolves over time, names sometimes change or old features are removed to make way for new features. To ease transition, Boost.Filesystem deprecates the old names and features, but by default continues to provide many of them. The deprecated names and other workarounds can be suppressed by defining macro `BOOST_FILESYSTEM_NO_DEPRECATED`, and this is recommended for all new code.

In the table, ✔ indicates a synonym or other workaround is provided unless `BOOST_FILESYSTEM_NO_DEPRECATED` is defined.

Component or location | Old name, now deprecated | ✔ | New name
`class path` | `branch_path()` | ✔ | `parent_path()`
`class path` | `canonize()` |  | Function removed
`class path` | `default_name_check()` | ✔ | Function removed
`class path` | `default_name_check(name_check)` | ✔ | Function removed
`class path` | `default_name_check_writable()` | ✔ | Function removed
`class path` | `directory_string()` | ✔ | `string`
`class path` | `external_directory_string()` | ✔ | `native()`
`class path` | `external_file_string()` | ✔ | `native()`
`class path` | `file_string()` | ✔ | `string()`
`class path` | `has_branch_path()` | ✔ | `has_parent_path()`
`class path` | `has_leaf()` | ✔ | `has_filename()`
`class path` | `is_complere()` | ✔ | `is_absolute()`
`class path` | `leaf()` | ✔ | `filename()`
`class path` | `native_directory_string()` | ✔ | `string()`
`class path` | `native_file_string()` | ✔ | `string()`
`class path` | `normalize()` | ✔ | Function removed
`class path` | `path(const string_type& str, name_check)` | ✔ | Function removed. Workaround ignores `name_check` argument.
`class path` | `path(const string_type::value_type* s, name_check)` | ✔ | Function removed. Workaround ignores `name_check` argument.
`class path` | `remove_leaf()` | ✔ | `remove_filename()`
`path.hpp` | `template<class String, class Traits> class basic_path;` |  | Class template `basic_path` is replaced by `class path`. No workaround for an explicitly coded `basic_path` is provided, but see the next row - `path`.
`path.hpp` | `typedef basic_path<std::string, path_traits> path` | ✔ | `class path`
`path.hpp` | `typedef basic_path<std::wstring, wpath_traits> wpath` | ✔ | Removed; use `class path` instead. Workaround provides `typedef path wpath`
`operations.hpp` | `initial_path()` | ✔ | Function removed
`operations.hpp` | `template <class Path> Path complete(const Path& p, const Path& base= initial_path<Path>())` | ✔ | `path absolute(const path& p, const path& base= current_path())`
`operations.hpp` | `is_regular(file_status f)` | ✔ | `is_regular_file(file_status f)`
`operations.hpp` | `symbolic_link_exists(const path& ph)` |  | Function removed
`class directory_entry` | `filename()` | ✔ | Function removed, use `path().filename()` instead.
`class directory_entry` | `leaf()` | ✔ | Function removed, use `path().filename()` instead.
`class directory_entry` | `string()` | ✔ | Function removed, use `path().string()` instead.
Macro definitions | `BOOST_WINDOW_API` |  | No longer supported; API selection is always automatic.
Macro definitions | `BOOST_POSIX_API` |  | No longer supported; API selection is always automatic.
Macro definitions | `BOOST_WINDOW_PATH` |  | No longer supported; native path format selection is always automatic.
Macro definitions | `BOOST_POSIX_PATH` |  | No longer supported; native path format selection is always automatic.

## Deprecation rationale

### `initial_path` function

Full implementation of `initial_path()` would require support from the C++ runtime startup code, and that doesn't seem likely to happen. Depending on the user to call `initial_path()` at the beginning of `main()` is too error prone. An equivalent function can trivially be provided by a user.

Revised 20 March, 2012

© Copyright Beman Dawes, 2002-2005, 2010

Use, modification, and distribution are subject to the Boost Software License, Version 1.0. See www.boost.org/LICENSE_1_0.txt