boost::urls::segments_view :: Boost Libraries Documentation

# boost::urls::segments_view

A view representing path segments in a URL

## Synopsis

Declared in `<boost/url/segments_view.hpp>`

    class segments_view
        : public segments_base;

## Base Classes

Name | Description
`segments_base` | Common functionality for containers

## Types

Name | Description
`iterator` | A Bidirectional iterator to a path segment
`const_iterator` | A Bidirectional iterator to a path segment
`const_reference` | The reference type
`difference_type` | A signed integer type used to represent differences.
`reference` | The reference type
`size_type` | An unsigned integer type used to represent size.
`value_type` | The value type

## Member Functions

Name | Description
`segments_view` [constructor] | Constructor
`operator=` | Assignment
`back` | Return the last segment
`begin` | Return an iterator to the beginning
`buffer` | Return the referenced character buffer.
`empty` | Return true if there are no segments
`end` | Return an iterator to the end
`front` | Return the first segment
`is_absolute` | Returns true if this references an absolute path.
`size` | Return the number of segments

## Static Member Functions

Name | Description
`max_size` | Return the maximum number of characters possible

## Friends

Name | Description
`boost::urls::segments_ref` | A view representing path segments in a URL
`boost::urls::segments_encoded_view` | A view representing path segments in a URL
`boost::urls::url_view_base` | Common functionality for containers

## Description

Objects of this type are used to interpret the path as a bidirectional view of segment strings.

The view does not retain ownership of the elements and instead references the original character buffer. The caller is responsible for ensuring that the lifetime of the buffer extends until it is no longer referenced.

## Example

    url_view u( "/path/to/file.txt" );

    segments_view ps = u.segments();

    assert( ps.buffer().data() == u.buffer().data() );

Percent escapes in strings returned when dereferencing iterators are automatically decoded.

## Iterator Invalidation

Changes to the underlying character buffer can invalidate iterators which reference it.

## See Also

`segments_encoded_view`, `segments_encoded_ref`, `segments_ref`.

Created with MrDocs