boost::urls::string_token::arg

Base class for string tokens, and algorithm parameters

Synopsis

struct arg;
cpp

Member Functions

Name Description

arg [constructor]

Default constructor

Default move constructor

Deleted copy constructor

operator= [deleted]

Deleted copy assignment

Deleted move assignment

prepare [virtual]

Return a modifiable character buffer

˜arg [destructor] [virtual]

Virtual destructor

Description

This abstract interface provides a means for an algorithm to generically obtain a modifiable, contiguous character buffer of prescribed size.

A StringToken should be derived from this class. As the author of an algorithm using a StringToken, simply declare an rvalue reference as a parameter type.

Instances of this type are intended only to be used once and then destroyed.

Example

The declared function accepts any temporary instance of arg to be used for writing:

void algorithm( string_token::arg&& dest );
cpp

To implement the interface for your type or use‐case, derive from the class and implement the prepare function.

Created with MrDocs