1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755 |
- //
- // buffer.hpp
- // ~~~~~~~~~~
- //
- // Copyright (c) 2003-2024 Christopher M. Kohlhoff (chris at kohlhoff dot com)
- //
- // Distributed under the Boost Software License, Version 1.0. (See accompanying
- // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
- //
- #ifndef BOOST_ASIO_BUFFER_HPP
- #define BOOST_ASIO_BUFFER_HPP
- #if defined(_MSC_VER) && (_MSC_VER >= 1200)
- # pragma once
- #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
- #include <boost/asio/detail/config.hpp>
- #include <cstddef>
- #include <cstring>
- #include <limits>
- #include <stdexcept>
- #include <string>
- #include <vector>
- #include <boost/asio/detail/array_fwd.hpp>
- #include <boost/asio/detail/memory.hpp>
- #include <boost/asio/detail/string_view.hpp>
- #include <boost/asio/detail/throw_exception.hpp>
- #include <boost/asio/detail/type_traits.hpp>
- #include <boost/asio/is_contiguous_iterator.hpp>
- #if defined(BOOST_ASIO_MSVC) && (BOOST_ASIO_MSVC >= 1700)
- # if defined(_HAS_ITERATOR_DEBUGGING) && (_HAS_ITERATOR_DEBUGGING != 0)
- # if !defined(BOOST_ASIO_DISABLE_BUFFER_DEBUGGING)
- # define BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- # endif // !defined(BOOST_ASIO_DISABLE_BUFFER_DEBUGGING)
- # endif // defined(_HAS_ITERATOR_DEBUGGING)
- #endif // defined(BOOST_ASIO_MSVC) && (BOOST_ASIO_MSVC >= 1700)
- #if defined(__GNUC__)
- # if defined(_GLIBCXX_DEBUG)
- # if !defined(BOOST_ASIO_DISABLE_BUFFER_DEBUGGING)
- # define BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- # endif // !defined(BOOST_ASIO_DISABLE_BUFFER_DEBUGGING)
- # endif // defined(_GLIBCXX_DEBUG)
- #endif // defined(__GNUC__)
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- # include <boost/asio/detail/functional.hpp>
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- #include <boost/asio/detail/push_options.hpp>
- namespace boost {
- namespace asio {
- class mutable_buffer;
- class const_buffer;
- /// Holds a buffer that can be modified.
- /**
- * The mutable_buffer class provides a safe representation of a buffer that can
- * be modified. It does not own the underlying data, and so is cheap to copy or
- * assign.
- *
- * @par Accessing Buffer Contents
- *
- * The contents of a buffer may be accessed using the @c data() and @c size()
- * member functions:
- *
- * @code boost::asio::mutable_buffer b1 = ...;
- * std::size_t s1 = b1.size();
- * unsigned char* p1 = static_cast<unsigned char*>(b1.data());
- * @endcode
- *
- * The @c data() member function permits violations of type safety, so uses of
- * it in application code should be carefully considered.
- */
- class mutable_buffer
- {
- public:
- /// Construct an empty buffer.
- mutable_buffer() noexcept
- : data_(0),
- size_(0)
- {
- }
- /// Construct a buffer to represent a given memory range.
- mutable_buffer(void* data, std::size_t size) noexcept
- : data_(data),
- size_(size)
- {
- }
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- mutable_buffer(void* data, std::size_t size,
- boost::asio::detail::function<void()> debug_check)
- : data_(data),
- size_(size),
- debug_check_(debug_check)
- {
- }
- const boost::asio::detail::function<void()>& get_debug_check() const
- {
- return debug_check_;
- }
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- /// Get a pointer to the beginning of the memory range.
- void* data() const noexcept
- {
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- if (size_ && debug_check_)
- debug_check_();
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- return data_;
- }
- /// Get the size of the memory range.
- std::size_t size() const noexcept
- {
- return size_;
- }
- /// Move the start of the buffer by the specified number of bytes.
- mutable_buffer& operator+=(std::size_t n) noexcept
- {
- std::size_t offset = n < size_ ? n : size_;
- data_ = static_cast<char*>(data_) + offset;
- size_ -= offset;
- return *this;
- }
- private:
- void* data_;
- std::size_t size_;
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- boost::asio::detail::function<void()> debug_check_;
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- };
- #if !defined(BOOST_ASIO_NO_DEPRECATED)
- /// (Deprecated: Use mutable_buffer.) Adapts a single modifiable buffer so that
- /// it meets the requirements of the MutableBufferSequence concept.
- class mutable_buffers_1
- : public mutable_buffer
- {
- public:
- /// The type for each element in the list of buffers.
- typedef mutable_buffer value_type;
- /// A random-access iterator type that may be used to read elements.
- typedef const mutable_buffer* const_iterator;
- /// Construct to represent a given memory range.
- mutable_buffers_1(void* data, std::size_t size) noexcept
- : mutable_buffer(data, size)
- {
- }
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- mutable_buffers_1(void* data, std::size_t size,
- boost::asio::detail::function<void()> debug_check)
- : mutable_buffer(data, size, debug_check)
- {
- }
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- /// Construct to represent a single modifiable buffer.
- explicit mutable_buffers_1(const mutable_buffer& b) noexcept
- : mutable_buffer(b)
- {
- }
- /// Get a random-access iterator to the first element.
- const_iterator begin() const noexcept
- {
- return this;
- }
- /// Get a random-access iterator for one past the last element.
- const_iterator end() const noexcept
- {
- return begin() + 1;
- }
- };
- #endif // !defined(BOOST_ASIO_NO_DEPRECATED)
- /// Holds a buffer that cannot be modified.
- /**
- * The const_buffer class provides a safe representation of a buffer that cannot
- * be modified. It does not own the underlying data, and so is cheap to copy or
- * assign.
- *
- * @par Accessing Buffer Contents
- *
- * The contents of a buffer may be accessed using the @c data() and @c size()
- * member functions:
- *
- * @code boost::asio::const_buffer b1 = ...;
- * std::size_t s1 = b1.size();
- * const unsigned char* p1 = static_cast<const unsigned char*>(b1.data());
- * @endcode
- *
- * The @c data() member function permits violations of type safety, so uses of
- * it in application code should be carefully considered.
- */
- class const_buffer
- {
- public:
- /// Construct an empty buffer.
- const_buffer() noexcept
- : data_(0),
- size_(0)
- {
- }
- /// Construct a buffer to represent a given memory range.
- const_buffer(const void* data, std::size_t size) noexcept
- : data_(data),
- size_(size)
- {
- }
- /// Construct a non-modifiable buffer from a modifiable one.
- const_buffer(const mutable_buffer& b) noexcept
- : data_(b.data()),
- size_(b.size())
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , debug_check_(b.get_debug_check())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- {
- }
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- const_buffer(const void* data, std::size_t size,
- boost::asio::detail::function<void()> debug_check)
- : data_(data),
- size_(size),
- debug_check_(debug_check)
- {
- }
- const boost::asio::detail::function<void()>& get_debug_check() const
- {
- return debug_check_;
- }
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- /// Get a pointer to the beginning of the memory range.
- const void* data() const noexcept
- {
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- if (size_ && debug_check_)
- debug_check_();
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- return data_;
- }
- /// Get the size of the memory range.
- std::size_t size() const noexcept
- {
- return size_;
- }
- /// Move the start of the buffer by the specified number of bytes.
- const_buffer& operator+=(std::size_t n) noexcept
- {
- std::size_t offset = n < size_ ? n : size_;
- data_ = static_cast<const char*>(data_) + offset;
- size_ -= offset;
- return *this;
- }
- private:
- const void* data_;
- std::size_t size_;
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- boost::asio::detail::function<void()> debug_check_;
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- };
- #if !defined(BOOST_ASIO_NO_DEPRECATED)
- /// (Deprecated: Use const_buffer.) Adapts a single non-modifiable buffer so
- /// that it meets the requirements of the ConstBufferSequence concept.
- class const_buffers_1
- : public const_buffer
- {
- public:
- /// The type for each element in the list of buffers.
- typedef const_buffer value_type;
- /// A random-access iterator type that may be used to read elements.
- typedef const const_buffer* const_iterator;
- /// Construct to represent a given memory range.
- const_buffers_1(const void* data, std::size_t size) noexcept
- : const_buffer(data, size)
- {
- }
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- const_buffers_1(const void* data, std::size_t size,
- boost::asio::detail::function<void()> debug_check)
- : const_buffer(data, size, debug_check)
- {
- }
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- /// Construct to represent a single non-modifiable buffer.
- explicit const_buffers_1(const const_buffer& b) noexcept
- : const_buffer(b)
- {
- }
- /// Get a random-access iterator to the first element.
- const_iterator begin() const noexcept
- {
- return this;
- }
- /// Get a random-access iterator for one past the last element.
- const_iterator end() const noexcept
- {
- return begin() + 1;
- }
- };
- #endif // !defined(BOOST_ASIO_NO_DEPRECATED)
- /// (Deprecated: Use the socket/descriptor wait() and async_wait() member
- /// functions.) An implementation of both the ConstBufferSequence and
- /// MutableBufferSequence concepts to represent a null buffer sequence.
- class null_buffers
- {
- public:
- /// The type for each element in the list of buffers.
- typedef mutable_buffer value_type;
- /// A random-access iterator type that may be used to read elements.
- typedef const mutable_buffer* const_iterator;
- /// Get a random-access iterator to the first element.
- const_iterator begin() const noexcept
- {
- return &buf_;
- }
- /// Get a random-access iterator for one past the last element.
- const_iterator end() const noexcept
- {
- return &buf_;
- }
- private:
- mutable_buffer buf_;
- };
- /** @defgroup buffer_sequence_begin boost::asio::buffer_sequence_begin
- *
- * @brief The boost::asio::buffer_sequence_begin function returns an iterator
- * pointing to the first element in a buffer sequence.
- */
- /*@{*/
- /// Get an iterator to the first element in a buffer sequence.
- template <typename MutableBuffer>
- inline const mutable_buffer* buffer_sequence_begin(const MutableBuffer& b,
- constraint_t<
- is_convertible<const MutableBuffer*, const mutable_buffer*>::value
- > = 0) noexcept
- {
- return static_cast<const mutable_buffer*>(detail::addressof(b));
- }
- /// Get an iterator to the first element in a buffer sequence.
- template <typename ConstBuffer>
- inline const const_buffer* buffer_sequence_begin(const ConstBuffer& b,
- constraint_t<
- is_convertible<const ConstBuffer*, const const_buffer*>::value
- > = 0) noexcept
- {
- return static_cast<const const_buffer*>(detail::addressof(b));
- }
- /// Get an iterator to the first element in a buffer sequence.
- template <typename C>
- inline auto buffer_sequence_begin(C& c,
- constraint_t<
- !is_convertible<const C*, const mutable_buffer*>::value
- && !is_convertible<const C*, const const_buffer*>::value
- > = 0) noexcept -> decltype(c.begin())
- {
- return c.begin();
- }
- /// Get an iterator to the first element in a buffer sequence.
- template <typename C>
- inline auto buffer_sequence_begin(const C& c,
- constraint_t<
- !is_convertible<const C*, const mutable_buffer*>::value
- && !is_convertible<const C*, const const_buffer*>::value
- > = 0) noexcept -> decltype(c.begin())
- {
- return c.begin();
- }
- /*@}*/
- /** @defgroup buffer_sequence_end boost::asio::buffer_sequence_end
- *
- * @brief The boost::asio::buffer_sequence_end function returns an iterator
- * pointing to one past the end element in a buffer sequence.
- */
- /*@{*/
- /// Get an iterator to one past the end element in a buffer sequence.
- template <typename MutableBuffer>
- inline const mutable_buffer* buffer_sequence_end(const MutableBuffer& b,
- constraint_t<
- is_convertible<const MutableBuffer*, const mutable_buffer*>::value
- > = 0) noexcept
- {
- return static_cast<const mutable_buffer*>(detail::addressof(b)) + 1;
- }
- /// Get an iterator to one past the end element in a buffer sequence.
- template <typename ConstBuffer>
- inline const const_buffer* buffer_sequence_end(const ConstBuffer& b,
- constraint_t<
- is_convertible<const ConstBuffer*, const const_buffer*>::value
- > = 0) noexcept
- {
- return static_cast<const const_buffer*>(detail::addressof(b)) + 1;
- }
- /// Get an iterator to one past the end element in a buffer sequence.
- template <typename C>
- inline auto buffer_sequence_end(C& c,
- constraint_t<
- !is_convertible<const C*, const mutable_buffer*>::value
- && !is_convertible<const C*, const const_buffer*>::value
- > = 0) noexcept -> decltype(c.end())
- {
- return c.end();
- }
- /// Get an iterator to one past the end element in a buffer sequence.
- template <typename C>
- inline auto buffer_sequence_end(const C& c,
- constraint_t<
- !is_convertible<const C*, const mutable_buffer*>::value
- && !is_convertible<const C*, const const_buffer*>::value
- > = 0) noexcept -> decltype(c.end())
- {
- return c.end();
- }
- /*@}*/
- namespace detail {
- // Tag types used to select appropriately optimised overloads.
- struct one_buffer {};
- struct multiple_buffers {};
- // Helper trait to detect single buffers.
- template <typename BufferSequence>
- struct buffer_sequence_cardinality :
- conditional_t<
- is_same<BufferSequence, mutable_buffer>::value
- #if !defined(BOOST_ASIO_NO_DEPRECATED)
- || is_same<BufferSequence, mutable_buffers_1>::value
- || is_same<BufferSequence, const_buffers_1>::value
- #endif // !defined(BOOST_ASIO_NO_DEPRECATED)
- || is_same<BufferSequence, const_buffer>::value,
- one_buffer, multiple_buffers> {};
- template <typename Iterator>
- inline std::size_t buffer_size(one_buffer,
- Iterator begin, Iterator) noexcept
- {
- return const_buffer(*begin).size();
- }
- template <typename Iterator>
- inline std::size_t buffer_size(multiple_buffers,
- Iterator begin, Iterator end) noexcept
- {
- std::size_t total_buffer_size = 0;
- Iterator iter = begin;
- for (; iter != end; ++iter)
- {
- const_buffer b(*iter);
- total_buffer_size += b.size();
- }
- return total_buffer_size;
- }
- } // namespace detail
- /// Get the total number of bytes in a buffer sequence.
- /**
- * The @c buffer_size function determines the total size of all buffers in the
- * buffer sequence, as if computed as follows:
- *
- * @code size_t total_size = 0;
- * auto i = boost::asio::buffer_sequence_begin(buffers);
- * auto end = boost::asio::buffer_sequence_end(buffers);
- * for (; i != end; ++i)
- * {
- * const_buffer b(*i);
- * total_size += b.size();
- * }
- * return total_size; @endcode
- *
- * The @c BufferSequence template parameter may meet either of the @c
- * ConstBufferSequence or @c MutableBufferSequence type requirements.
- */
- template <typename BufferSequence>
- inline std::size_t buffer_size(const BufferSequence& b) noexcept
- {
- return detail::buffer_size(
- detail::buffer_sequence_cardinality<BufferSequence>(),
- boost::asio::buffer_sequence_begin(b),
- boost::asio::buffer_sequence_end(b));
- }
- #if !defined(BOOST_ASIO_NO_DEPRECATED)
- /** @defgroup buffer_cast boost::asio::buffer_cast
- *
- * @brief (Deprecated: Use the @c data() member function.) The
- * boost::asio::buffer_cast function is used to obtain a pointer to the
- * underlying memory region associated with a buffer.
- *
- * @par Examples:
- *
- * To access the memory of a non-modifiable buffer, use:
- * @code boost::asio::const_buffer b1 = ...;
- * const unsigned char* p1 = boost::asio::buffer_cast<const unsigned char*>(b1);
- * @endcode
- *
- * To access the memory of a modifiable buffer, use:
- * @code boost::asio::mutable_buffer b2 = ...;
- * unsigned char* p2 = boost::asio::buffer_cast<unsigned char*>(b2);
- * @endcode
- *
- * The boost::asio::buffer_cast function permits violations of type safety, so
- * uses of it in application code should be carefully considered.
- */
- /*@{*/
- /// Cast a non-modifiable buffer to a specified pointer to POD type.
- template <typename PointerToPodType>
- inline PointerToPodType buffer_cast(const mutable_buffer& b) noexcept
- {
- return static_cast<PointerToPodType>(b.data());
- }
- /// Cast a non-modifiable buffer to a specified pointer to POD type.
- template <typename PointerToPodType>
- inline PointerToPodType buffer_cast(const const_buffer& b) noexcept
- {
- return static_cast<PointerToPodType>(b.data());
- }
- /*@}*/
- #endif // !defined(BOOST_ASIO_NO_DEPRECATED)
- /// Create a new modifiable buffer that is offset from the start of another.
- /**
- * @relates mutable_buffer
- */
- inline mutable_buffer operator+(const mutable_buffer& b,
- std::size_t n) noexcept
- {
- std::size_t offset = n < b.size() ? n : b.size();
- char* new_data = static_cast<char*>(b.data()) + offset;
- std::size_t new_size = b.size() - offset;
- return mutable_buffer(new_data, new_size
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , b.get_debug_check()
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new modifiable buffer that is offset from the start of another.
- /**
- * @relates mutable_buffer
- */
- inline mutable_buffer operator+(std::size_t n,
- const mutable_buffer& b) noexcept
- {
- return b + n;
- }
- /// Create a new non-modifiable buffer that is offset from the start of another.
- /**
- * @relates const_buffer
- */
- inline const_buffer operator+(const const_buffer& b,
- std::size_t n) noexcept
- {
- std::size_t offset = n < b.size() ? n : b.size();
- const char* new_data = static_cast<const char*>(b.data()) + offset;
- std::size_t new_size = b.size() - offset;
- return const_buffer(new_data, new_size
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , b.get_debug_check()
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new non-modifiable buffer that is offset from the start of another.
- /**
- * @relates const_buffer
- */
- inline const_buffer operator+(std::size_t n,
- const const_buffer& b) noexcept
- {
- return b + n;
- }
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- namespace detail {
- template <typename Iterator>
- class buffer_debug_check
- {
- public:
- buffer_debug_check(Iterator iter)
- : iter_(iter)
- {
- }
- ~buffer_debug_check()
- {
- #if defined(BOOST_ASIO_MSVC) && (BOOST_ASIO_MSVC == 1400)
- // MSVC 8's string iterator checking may crash in a std::string::iterator
- // object's destructor when the iterator points to an already-destroyed
- // std::string object, unless the iterator is cleared first.
- iter_ = Iterator();
- #endif // defined(BOOST_ASIO_MSVC) && (BOOST_ASIO_MSVC == 1400)
- }
- void operator()()
- {
- (void)*iter_;
- }
- private:
- Iterator iter_;
- };
- } // namespace detail
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- /** @defgroup buffer boost::asio::buffer
- *
- * @brief The boost::asio::buffer function is used to create a buffer object to
- * represent raw memory, an array of POD elements, a vector of POD elements,
- * or a std::string.
- *
- * A buffer object represents a contiguous region of memory as a 2-tuple
- * consisting of a pointer and size in bytes. A tuple of the form <tt>{void*,
- * size_t}</tt> specifies a mutable (modifiable) region of memory. Similarly, a
- * tuple of the form <tt>{const void*, size_t}</tt> specifies a const
- * (non-modifiable) region of memory. These two forms correspond to the classes
- * mutable_buffer and const_buffer, respectively. To mirror C++'s conversion
- * rules, a mutable_buffer is implicitly convertible to a const_buffer, and the
- * opposite conversion is not permitted.
- *
- * The simplest use case involves reading or writing a single buffer of a
- * specified size:
- *
- * @code sock.send(boost::asio::buffer(data, size)); @endcode
- *
- * In the above example, the return value of boost::asio::buffer meets the
- * requirements of the ConstBufferSequence concept so that it may be directly
- * passed to the socket's write function. A buffer created for modifiable
- * memory also meets the requirements of the MutableBufferSequence concept.
- *
- * An individual buffer may be created from a builtin array, std::vector,
- * std::array or boost::array of POD elements. This helps prevent buffer
- * overruns by automatically determining the size of the buffer:
- *
- * @code char d1[128];
- * size_t bytes_transferred = sock.receive(boost::asio::buffer(d1));
- *
- * std::vector<char> d2(128);
- * bytes_transferred = sock.receive(boost::asio::buffer(d2));
- *
- * std::array<char, 128> d3;
- * bytes_transferred = sock.receive(boost::asio::buffer(d3));
- *
- * boost::array<char, 128> d4;
- * bytes_transferred = sock.receive(boost::asio::buffer(d4)); @endcode
- *
- * In all three cases above, the buffers created are exactly 128 bytes long.
- * Note that a vector is @e never automatically resized when creating or using
- * a buffer. The buffer size is determined using the vector's <tt>size()</tt>
- * member function, and not its capacity.
- *
- * @par Accessing Buffer Contents
- *
- * The contents of a buffer may be accessed using the @c data() and @c size()
- * member functions:
- *
- * @code boost::asio::mutable_buffer b1 = ...;
- * std::size_t s1 = b1.size();
- * unsigned char* p1 = static_cast<unsigned char*>(b1.data());
- *
- * boost::asio::const_buffer b2 = ...;
- * std::size_t s2 = b2.size();
- * const void* p2 = b2.data(); @endcode
- *
- * The @c data() member function permits violations of type safety, so
- * uses of it in application code should be carefully considered.
- *
- * For convenience, a @ref buffer_size function is provided that works with
- * both buffers and buffer sequences (that is, types meeting the
- * ConstBufferSequence or MutableBufferSequence type requirements). In this
- * case, the function returns the total size of all buffers in the sequence.
- *
- * @par Buffer Copying
- *
- * The @ref buffer_copy function may be used to copy raw bytes between
- * individual buffers and buffer sequences.
- *
- * In particular, when used with the @ref buffer_size function, the @ref
- * buffer_copy function can be used to linearise a sequence of buffers. For
- * example:
- *
- * @code vector<const_buffer> buffers = ...;
- *
- * vector<unsigned char> data(boost::asio::buffer_size(buffers));
- * boost::asio::buffer_copy(boost::asio::buffer(data), buffers); @endcode
- *
- * Note that @ref buffer_copy is implemented in terms of @c memcpy, and
- * consequently it cannot be used to copy between overlapping memory regions.
- *
- * @par Buffer Invalidation
- *
- * A buffer object does not have any ownership of the memory it refers to. It
- * is the responsibility of the application to ensure the memory region remains
- * valid until it is no longer required for an I/O operation. When the memory
- * is no longer available, the buffer is said to have been invalidated.
- *
- * For the boost::asio::buffer overloads that accept an argument of type
- * std::vector, the buffer objects returned are invalidated by any vector
- * operation that also invalidates all references, pointers and iterators
- * referring to the elements in the sequence (C++ Std, 23.2.4)
- *
- * For the boost::asio::buffer overloads that accept an argument of type
- * std::basic_string, the buffer objects returned are invalidated according to
- * the rules defined for invalidation of references, pointers and iterators
- * referring to elements of the sequence (C++ Std, 21.3).
- *
- * @par Buffer Arithmetic
- *
- * Buffer objects may be manipulated using simple arithmetic in a safe way
- * which helps prevent buffer overruns. Consider an array initialised as
- * follows:
- *
- * @code boost::array<char, 6> a = { 'a', 'b', 'c', 'd', 'e' }; @endcode
- *
- * A buffer object @c b1 created using:
- *
- * @code b1 = boost::asio::buffer(a); @endcode
- *
- * represents the entire array, <tt>{ 'a', 'b', 'c', 'd', 'e' }</tt>. An
- * optional second argument to the boost::asio::buffer function may be used to
- * limit the size, in bytes, of the buffer:
- *
- * @code b2 = boost::asio::buffer(a, 3); @endcode
- *
- * such that @c b2 represents the data <tt>{ 'a', 'b', 'c' }</tt>. Even if the
- * size argument exceeds the actual size of the array, the size of the buffer
- * object created will be limited to the array size.
- *
- * An offset may be applied to an existing buffer to create a new one:
- *
- * @code b3 = b1 + 2; @endcode
- *
- * where @c b3 will set to represent <tt>{ 'c', 'd', 'e' }</tt>. If the offset
- * exceeds the size of the existing buffer, the newly created buffer will be
- * empty.
- *
- * Both an offset and size may be specified to create a buffer that corresponds
- * to a specific range of bytes within an existing buffer:
- *
- * @code b4 = boost::asio::buffer(b1 + 1, 3); @endcode
- *
- * so that @c b4 will refer to the bytes <tt>{ 'b', 'c', 'd' }</tt>.
- *
- * @par Buffers and Scatter-Gather I/O
- *
- * To read or write using multiple buffers (i.e. scatter-gather I/O), multiple
- * buffer objects may be assigned into a container that supports the
- * MutableBufferSequence (for read) or ConstBufferSequence (for write) concepts:
- *
- * @code
- * char d1[128];
- * std::vector<char> d2(128);
- * boost::array<char, 128> d3;
- *
- * boost::array<mutable_buffer, 3> bufs1 = {
- * boost::asio::buffer(d1),
- * boost::asio::buffer(d2),
- * boost::asio::buffer(d3) };
- * bytes_transferred = sock.receive(bufs1);
- *
- * std::vector<const_buffer> bufs2;
- * bufs2.push_back(boost::asio::buffer(d1));
- * bufs2.push_back(boost::asio::buffer(d2));
- * bufs2.push_back(boost::asio::buffer(d3));
- * bytes_transferred = sock.send(bufs2); @endcode
- *
- * @par Buffer Literals
- *
- * The `_buf` literal suffix, defined in namespace
- * <tt>boost::asio::buffer_literals</tt>, may be used to create @c const_buffer
- * objects from string, binary integer, and hexadecimal integer literals.
- * For example:
- *
- * @code
- * using namespace boost::asio::buffer_literals;
- *
- * boost::asio::const_buffer b1 = "hello"_buf;
- * boost::asio::const_buffer b2 = 0xdeadbeef_buf;
- * boost::asio::const_buffer b3 = 0x0123456789abcdef0123456789abcdef_buf;
- * boost::asio::const_buffer b4 = 0b1010101011001100_buf; @endcode
- *
- * Note that the memory associated with a buffer literal is valid for the
- * lifetime of the program. This means that the buffer can be safely used with
- * asynchronous operations.
- */
- /*@{*/
- #if defined(BOOST_ASIO_NO_DEPRECATED) || defined(GENERATING_DOCUMENTATION)
- # define BOOST_ASIO_MUTABLE_BUFFER mutable_buffer
- # define BOOST_ASIO_CONST_BUFFER const_buffer
- #else // defined(BOOST_ASIO_NO_DEPRECATED) || defined(GENERATING_DOCUMENTATION)
- # define BOOST_ASIO_MUTABLE_BUFFER mutable_buffers_1
- # define BOOST_ASIO_CONST_BUFFER const_buffers_1
- #endif // defined(BOOST_ASIO_NO_DEPRECATED) || defined(GENERATING_DOCUMENTATION)
- /// Create a new modifiable buffer from an existing buffer.
- /**
- * @returns <tt>mutable_buffer(b)</tt>.
- */
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- const mutable_buffer& b) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(b);
- }
- /// Create a new modifiable buffer from an existing buffer.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * b.data(),
- * min(b.size(), max_size_in_bytes)); @endcode
- */
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- const mutable_buffer& b,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(
- mutable_buffer(b.data(),
- b.size() < max_size_in_bytes
- ? b.size() : max_size_in_bytes
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , b.get_debug_check()
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- ));
- }
- /// Create a new non-modifiable buffer from an existing buffer.
- /**
- * @returns <tt>const_buffer(b)</tt>.
- */
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const const_buffer& b) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(b);
- }
- /// Create a new non-modifiable buffer from an existing buffer.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * b.data(),
- * min(b.size(), max_size_in_bytes)); @endcode
- */
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const const_buffer& b,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(b.data(),
- b.size() < max_size_in_bytes
- ? b.size() : max_size_in_bytes
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , b.get_debug_check()
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new modifiable buffer that represents the given memory range.
- /**
- * @returns <tt>mutable_buffer(data, size_in_bytes)</tt>.
- */
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- void* data, std::size_t size_in_bytes) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data, size_in_bytes);
- }
- /// Create a new non-modifiable buffer that represents the given memory range.
- /**
- * @returns <tt>const_buffer(data, size_in_bytes)</tt>.
- */
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const void* data, std::size_t size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data, size_in_bytes);
- }
- /// Create a new modifiable buffer that represents the given POD array.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * static_cast<void*>(data),
- * N * sizeof(PodType)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- PodType (&data)[N]) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data, N * sizeof(PodType));
- }
-
- /// Create a new modifiable buffer that represents the given POD array.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * static_cast<void*>(data),
- * min(N * sizeof(PodType), max_size_in_bytes)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- PodType (&data)[N],
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data,
- N * sizeof(PodType) < max_size_in_bytes
- ? N * sizeof(PodType) : max_size_in_bytes);
- }
-
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * static_cast<const void*>(data),
- * N * sizeof(PodType)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const PodType (&data)[N]) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data, N * sizeof(PodType));
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * static_cast<const void*>(data),
- * min(N * sizeof(PodType), max_size_in_bytes)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const PodType (&data)[N],
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data,
- N * sizeof(PodType) < max_size_in_bytes
- ? N * sizeof(PodType) : max_size_in_bytes);
- }
- /// Create a new modifiable buffer that represents the given POD array.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.data(),
- * data.size() * sizeof(PodType)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- boost::array<PodType, N>& data) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(
- data.c_array(), data.size() * sizeof(PodType));
- }
- /// Create a new modifiable buffer that represents the given POD array.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.data(),
- * min(data.size() * sizeof(PodType), max_size_in_bytes)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- boost::array<PodType, N>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data.c_array(),
- data.size() * sizeof(PodType) < max_size_in_bytes
- ? data.size() * sizeof(PodType) : max_size_in_bytes);
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * data.size() * sizeof(PodType)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- boost::array<const PodType, N>& data) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(), data.size() * sizeof(PodType));
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * min(data.size() * sizeof(PodType), max_size_in_bytes)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- boost::array<const PodType, N>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(),
- data.size() * sizeof(PodType) < max_size_in_bytes
- ? data.size() * sizeof(PodType) : max_size_in_bytes);
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * data.size() * sizeof(PodType)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const boost::array<PodType, N>& data) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(), data.size() * sizeof(PodType));
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * min(data.size() * sizeof(PodType), max_size_in_bytes)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const boost::array<PodType, N>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(),
- data.size() * sizeof(PodType) < max_size_in_bytes
- ? data.size() * sizeof(PodType) : max_size_in_bytes);
- }
- /// Create a new modifiable buffer that represents the given POD array.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.data(),
- * data.size() * sizeof(PodType)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- std::array<PodType, N>& data) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data.data(), data.size() * sizeof(PodType));
- }
- /// Create a new modifiable buffer that represents the given POD array.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.data(),
- * min(data.size() * sizeof(PodType), max_size_in_bytes)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- std::array<PodType, N>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data.data(),
- data.size() * sizeof(PodType) < max_size_in_bytes
- ? data.size() * sizeof(PodType) : max_size_in_bytes);
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * data.size() * sizeof(PodType)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- std::array<const PodType, N>& data) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(), data.size() * sizeof(PodType));
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * min(data.size() * sizeof(PodType), max_size_in_bytes)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- std::array<const PodType, N>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(),
- data.size() * sizeof(PodType) < max_size_in_bytes
- ? data.size() * sizeof(PodType) : max_size_in_bytes);
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * data.size() * sizeof(PodType)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const std::array<PodType, N>& data) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(), data.size() * sizeof(PodType));
- }
- /// Create a new non-modifiable buffer that represents the given POD array.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * min(data.size() * sizeof(PodType), max_size_in_bytes)); @endcode
- */
- template <typename PodType, std::size_t N>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const std::array<PodType, N>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(),
- data.size() * sizeof(PodType) < max_size_in_bytes
- ? data.size() * sizeof(PodType) : max_size_in_bytes);
- }
- /// Create a new modifiable buffer that represents the given POD vector.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.size() ? &data[0] : 0,
- * data.size() * sizeof(PodType)); @endcode
- *
- * @note The buffer is invalidated by any vector operation that would also
- * invalidate iterators.
- */
- template <typename PodType, typename Allocator>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- std::vector<PodType, Allocator>& data) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(
- data.size() ? &data[0] : 0, data.size() * sizeof(PodType)
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename std::vector<PodType, Allocator>::iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new modifiable buffer that represents the given POD vector.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.size() ? &data[0] : 0,
- * min(data.size() * sizeof(PodType), max_size_in_bytes)); @endcode
- *
- * @note The buffer is invalidated by any vector operation that would also
- * invalidate iterators.
- */
- template <typename PodType, typename Allocator>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- std::vector<PodType, Allocator>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data.size() ? &data[0] : 0,
- data.size() * sizeof(PodType) < max_size_in_bytes
- ? data.size() * sizeof(PodType) : max_size_in_bytes
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename std::vector<PodType, Allocator>::iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new non-modifiable buffer that represents the given POD vector.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.size() ? &data[0] : 0,
- * data.size() * sizeof(PodType)); @endcode
- *
- * @note The buffer is invalidated by any vector operation that would also
- * invalidate iterators.
- */
- template <typename PodType, typename Allocator>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const std::vector<PodType, Allocator>& data) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(
- data.size() ? &data[0] : 0, data.size() * sizeof(PodType)
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename std::vector<PodType, Allocator>::const_iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new non-modifiable buffer that represents the given POD vector.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.size() ? &data[0] : 0,
- * min(data.size() * sizeof(PodType), max_size_in_bytes)); @endcode
- *
- * @note The buffer is invalidated by any vector operation that would also
- * invalidate iterators.
- */
- template <typename PodType, typename Allocator>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const std::vector<PodType, Allocator>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.size() ? &data[0] : 0,
- data.size() * sizeof(PodType) < max_size_in_bytes
- ? data.size() * sizeof(PodType) : max_size_in_bytes
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename std::vector<PodType, Allocator>::const_iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new modifiable buffer that represents the given string.
- /**
- * @returns <tt>mutable_buffer(data.size() ? &data[0] : 0,
- * data.size() * sizeof(Elem))</tt>.
- *
- * @note The buffer is invalidated by any non-const operation called on the
- * given string object.
- */
- template <typename Elem, typename Traits, typename Allocator>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- std::basic_string<Elem, Traits, Allocator>& data) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data.size() ? &data[0] : 0,
- data.size() * sizeof(Elem)
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename std::basic_string<Elem, Traits, Allocator>::iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new modifiable buffer that represents the given string.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.size() ? &data[0] : 0,
- * min(data.size() * sizeof(Elem), max_size_in_bytes)); @endcode
- *
- * @note The buffer is invalidated by any non-const operation called on the
- * given string object.
- */
- template <typename Elem, typename Traits, typename Allocator>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- std::basic_string<Elem, Traits, Allocator>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(data.size() ? &data[0] : 0,
- data.size() * sizeof(Elem) < max_size_in_bytes
- ? data.size() * sizeof(Elem) : max_size_in_bytes
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename std::basic_string<Elem, Traits, Allocator>::iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new non-modifiable buffer that represents the given string.
- /**
- * @returns <tt>const_buffer(data.data(), data.size() * sizeof(Elem))</tt>.
- *
- * @note The buffer is invalidated by any non-const operation called on the
- * given string object.
- */
- template <typename Elem, typename Traits, typename Allocator>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const std::basic_string<Elem, Traits, Allocator>& data) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(), data.size() * sizeof(Elem)
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename std::basic_string<Elem, Traits, Allocator>::const_iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new non-modifiable buffer that represents the given string.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.data(),
- * min(data.size() * sizeof(Elem), max_size_in_bytes)); @endcode
- *
- * @note The buffer is invalidated by any non-const operation called on the
- * given string object.
- */
- template <typename Elem, typename Traits, typename Allocator>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const std::basic_string<Elem, Traits, Allocator>& data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.data(),
- data.size() * sizeof(Elem) < max_size_in_bytes
- ? data.size() * sizeof(Elem) : max_size_in_bytes
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename std::basic_string<Elem, Traits, Allocator>::const_iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- #if defined(BOOST_ASIO_HAS_STRING_VIEW) \
- || defined(GENERATING_DOCUMENTATION)
- /// Create a new non-modifiable buffer that represents the given string_view.
- /**
- * @returns <tt>mutable_buffer(data.size() ? &data[0] : 0,
- * data.size() * sizeof(Elem))</tt>.
- */
- template <typename Elem, typename Traits>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- basic_string_view<Elem, Traits> data) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.size() ? &data[0] : 0,
- data.size() * sizeof(Elem)
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename basic_string_view<Elem, Traits>::iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- /// Create a new non-modifiable buffer that represents the given string.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.size() ? &data[0] : 0,
- * min(data.size() * sizeof(Elem), max_size_in_bytes)); @endcode
- */
- template <typename Elem, typename Traits>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- basic_string_view<Elem, Traits> data,
- std::size_t max_size_in_bytes) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(data.size() ? &data[0] : 0,
- data.size() * sizeof(Elem) < max_size_in_bytes
- ? data.size() * sizeof(Elem) : max_size_in_bytes
- #if defined(BOOST_ASIO_ENABLE_BUFFER_DEBUGGING)
- , detail::buffer_debug_check<
- typename basic_string_view<Elem, Traits>::iterator
- >(data.begin())
- #endif // BOOST_ASIO_ENABLE_BUFFER_DEBUGGING
- );
- }
- #endif // defined(BOOST_ASIO_HAS_STRING_VIEW)
- // || defined(GENERATING_DOCUMENTATION)
- /// Create a new modifiable buffer from a contiguous container.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.size() ? &data[0] : 0,
- * data.size() * sizeof(typename T::value_type)); @endcode
- */
- template <typename T>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- T& data,
- constraint_t<
- is_contiguous_iterator<typename T::iterator>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, const_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, mutable_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_const<
- remove_reference_t<
- typename std::iterator_traits<typename T::iterator>::reference
- >
- >::value,
- defaulted_constraint
- > = defaulted_constraint()) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(
- data.size() ? detail::to_address(data.begin()) : 0,
- data.size() * sizeof(typename T::value_type));
- }
- /// Create a new modifiable buffer from a contiguous container.
- /**
- * @returns A mutable_buffer value equivalent to:
- * @code mutable_buffer(
- * data.size() ? &data[0] : 0,
- * min(
- * data.size() * sizeof(typename T::value_type),
- * max_size_in_bytes)); @endcode
- */
- template <typename T>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_MUTABLE_BUFFER buffer(
- T& data, std::size_t max_size_in_bytes,
- constraint_t<
- is_contiguous_iterator<typename T::iterator>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, const_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, mutable_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_const<
- remove_reference_t<
- typename std::iterator_traits<typename T::iterator>::reference
- >
- >::value,
- defaulted_constraint
- > = defaulted_constraint()) noexcept
- {
- return BOOST_ASIO_MUTABLE_BUFFER(
- data.size() ? detail::to_address(data.begin()) : 0,
- data.size() * sizeof(typename T::value_type) < max_size_in_bytes
- ? data.size() * sizeof(typename T::value_type) : max_size_in_bytes);
- }
- /// Create a new non-modifiable buffer from a contiguous container.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.size() ? &data[0] : 0,
- * data.size() * sizeof(typename T::value_type)); @endcode
- */
- template <typename T>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- T& data,
- constraint_t<
- is_contiguous_iterator<typename T::iterator>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, const_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, mutable_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- is_const<
- remove_reference_t<
- typename std::iterator_traits<typename T::iterator>::reference
- >
- >::value,
- defaulted_constraint
- > = defaulted_constraint()) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(
- data.size() ? detail::to_address(data.begin()) : 0,
- data.size() * sizeof(typename T::value_type));
- }
- /// Create a new non-modifiable buffer from a contiguous container.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.size() ? &data[0] : 0,
- * min(
- * data.size() * sizeof(typename T::value_type),
- * max_size_in_bytes)); @endcode
- */
- template <typename T>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- T& data, std::size_t max_size_in_bytes,
- constraint_t<
- is_contiguous_iterator<typename T::iterator>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, const_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, mutable_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- is_const<
- remove_reference_t<
- typename std::iterator_traits<typename T::iterator>::reference
- >
- >::value,
- defaulted_constraint
- > = defaulted_constraint()) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(
- data.size() ? detail::to_address(data.begin()) : 0,
- data.size() * sizeof(typename T::value_type) < max_size_in_bytes
- ? data.size() * sizeof(typename T::value_type) : max_size_in_bytes);
- }
- /// Create a new non-modifiable buffer from a contiguous container.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.size() ? &data[0] : 0,
- * data.size() * sizeof(typename T::value_type)); @endcode
- */
- template <typename T>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const T& data,
- constraint_t<
- is_contiguous_iterator<typename T::const_iterator>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, const_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, mutable_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint()) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(
- data.size() ? detail::to_address(data.begin()) : 0,
- data.size() * sizeof(typename T::value_type));
- }
- /// Create a new non-modifiable buffer from a contiguous container.
- /**
- * @returns A const_buffer value equivalent to:
- * @code const_buffer(
- * data.size() ? &data[0] : 0,
- * min(
- * data.size() * sizeof(typename T::value_type),
- * max_size_in_bytes)); @endcode
- */
- template <typename T>
- BOOST_ASIO_NODISCARD inline BOOST_ASIO_CONST_BUFFER buffer(
- const T& data, std::size_t max_size_in_bytes,
- constraint_t<
- is_contiguous_iterator<typename T::const_iterator>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, const_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint(),
- constraint_t<
- !is_convertible<T, mutable_buffer>::value,
- defaulted_constraint
- > = defaulted_constraint()) noexcept
- {
- return BOOST_ASIO_CONST_BUFFER(
- data.size() ? detail::to_address(data.begin()) : 0,
- data.size() * sizeof(typename T::value_type) < max_size_in_bytes
- ? data.size() * sizeof(typename T::value_type) : max_size_in_bytes);
- }
- /*@}*/
- /// Adapt a basic_string to the DynamicBuffer requirements.
- /**
- * Requires that <tt>sizeof(Elem) == 1</tt>.
- */
- template <typename Elem, typename Traits, typename Allocator>
- class dynamic_string_buffer
- {
- public:
- /// The type used to represent a sequence of constant buffers that refers to
- /// the underlying memory.
- typedef BOOST_ASIO_CONST_BUFFER const_buffers_type;
- /// The type used to represent a sequence of mutable buffers that refers to
- /// the underlying memory.
- typedef BOOST_ASIO_MUTABLE_BUFFER mutable_buffers_type;
- /// Construct a dynamic buffer from a string.
- /**
- * @param s The string to be used as backing storage for the dynamic buffer.
- * The object stores a reference to the string and the user is responsible
- * for ensuring that the string object remains valid while the
- * dynamic_string_buffer object, and copies of the object, are in use.
- *
- * @b DynamicBuffer_v1: Any existing data in the string is treated as the
- * dynamic buffer's input sequence.
- *
- * @param maximum_size Specifies a maximum size for the buffer, in bytes.
- */
- explicit dynamic_string_buffer(std::basic_string<Elem, Traits, Allocator>& s,
- std::size_t maximum_size =
- (std::numeric_limits<std::size_t>::max)()) noexcept
- : string_(s),
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- size_((std::numeric_limits<std::size_t>::max)()),
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- max_size_(maximum_size)
- {
- }
- /// @b DynamicBuffer_v2: Copy construct a dynamic buffer.
- dynamic_string_buffer(const dynamic_string_buffer& other) noexcept
- : string_(other.string_),
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- size_(other.size_),
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- max_size_(other.max_size_)
- {
- }
- /// Move construct a dynamic buffer.
- dynamic_string_buffer(dynamic_string_buffer&& other) noexcept
- : string_(other.string_),
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- size_(other.size_),
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- max_size_(other.max_size_)
- {
- }
- /// @b DynamicBuffer_v1: Get the size of the input sequence.
- /// @b DynamicBuffer_v2: Get the current size of the underlying memory.
- /**
- * @returns @b DynamicBuffer_v1 The current size of the input sequence.
- * @b DynamicBuffer_v2: The current size of the underlying string if less than
- * max_size(). Otherwise returns max_size().
- */
- std::size_t size() const noexcept
- {
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- if (size_ != (std::numeric_limits<std::size_t>::max)())
- return size_;
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- return (std::min)(string_.size(), max_size());
- }
- /// Get the maximum size of the dynamic buffer.
- /**
- * @returns The allowed maximum size of the underlying memory.
- */
- std::size_t max_size() const noexcept
- {
- return max_size_;
- }
- /// Get the maximum size that the buffer may grow to without triggering
- /// reallocation.
- /**
- * @returns The current capacity of the underlying string if less than
- * max_size(). Otherwise returns max_size().
- */
- std::size_t capacity() const noexcept
- {
- return (std::min)(string_.capacity(), max_size());
- }
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// @b DynamicBuffer_v1: Get a list of buffers that represents the input
- /// sequence.
- /**
- * @returns An object of type @c const_buffers_type that satisfies
- * ConstBufferSequence requirements, representing the basic_string memory in
- * the input sequence.
- *
- * @note The returned object is invalidated by any @c dynamic_string_buffer
- * or @c basic_string member function that resizes or erases the string.
- */
- const_buffers_type data() const noexcept
- {
- return const_buffers_type(boost::asio::buffer(string_, size_));
- }
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// @b DynamicBuffer_v2: Get a sequence of buffers that represents the
- /// underlying memory.
- /**
- * @param pos Position of the first byte to represent in the buffer sequence
- *
- * @param n The number of bytes to return in the buffer sequence. If the
- * underlying memory is shorter, the buffer sequence represents as many bytes
- * as are available.
- *
- * @returns An object of type @c mutable_buffers_type that satisfies
- * MutableBufferSequence requirements, representing the basic_string memory.
- *
- * @note The returned object is invalidated by any @c dynamic_string_buffer
- * or @c basic_string member function that resizes or erases the string.
- */
- mutable_buffers_type data(std::size_t pos, std::size_t n) noexcept
- {
- return mutable_buffers_type(boost::asio::buffer(
- boost::asio::buffer(string_, max_size_) + pos, n));
- }
- /// @b DynamicBuffer_v2: Get a sequence of buffers that represents the
- /// underlying memory.
- /**
- * @param pos Position of the first byte to represent in the buffer sequence
- *
- * @param n The number of bytes to return in the buffer sequence. If the
- * underlying memory is shorter, the buffer sequence represents as many bytes
- * as are available.
- *
- * @note The returned object is invalidated by any @c dynamic_string_buffer
- * or @c basic_string member function that resizes or erases the string.
- */
- const_buffers_type data(std::size_t pos,
- std::size_t n) const noexcept
- {
- return const_buffers_type(boost::asio::buffer(
- boost::asio::buffer(string_, max_size_) + pos, n));
- }
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// @b DynamicBuffer_v1: Get a list of buffers that represents the output
- /// sequence, with the given size.
- /**
- * Ensures that the output sequence can accommodate @c n bytes, resizing the
- * basic_string object as necessary.
- *
- * @returns An object of type @c mutable_buffers_type that satisfies
- * MutableBufferSequence requirements, representing basic_string memory
- * at the start of the output sequence of size @c n.
- *
- * @throws std::length_error If <tt>size() + n > max_size()</tt>.
- *
- * @note The returned object is invalidated by any @c dynamic_string_buffer
- * or @c basic_string member function that modifies the input sequence or
- * output sequence.
- */
- mutable_buffers_type prepare(std::size_t n)
- {
- if (size() > max_size() || max_size() - size() < n)
- {
- std::length_error ex("dynamic_string_buffer too long");
- boost::asio::detail::throw_exception(ex);
- }
- if (size_ == (std::numeric_limits<std::size_t>::max)())
- size_ = string_.size(); // Enable v1 behaviour.
- string_.resize(size_ + n);
- return boost::asio::buffer(boost::asio::buffer(string_) + size_, n);
- }
- /// @b DynamicBuffer_v1: Move bytes from the output sequence to the input
- /// sequence.
- /**
- * @param n The number of bytes to append from the start of the output
- * sequence to the end of the input sequence. The remainder of the output
- * sequence is discarded.
- *
- * Requires a preceding call <tt>prepare(x)</tt> where <tt>x >= n</tt>, and
- * no intervening operations that modify the input or output sequence.
- *
- * @note If @c n is greater than the size of the output sequence, the entire
- * output sequence is moved to the input sequence and no error is issued.
- */
- void commit(std::size_t n)
- {
- size_ += (std::min)(n, string_.size() - size_);
- string_.resize(size_);
- }
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// @b DynamicBuffer_v2: Grow the underlying memory by the specified number of
- /// bytes.
- /**
- * Resizes the string to accommodate an additional @c n bytes at the end.
- *
- * @throws std::length_error If <tt>size() + n > max_size()</tt>.
- */
- void grow(std::size_t n)
- {
- if (size() > max_size() || max_size() - size() < n)
- {
- std::length_error ex("dynamic_string_buffer too long");
- boost::asio::detail::throw_exception(ex);
- }
- string_.resize(size() + n);
- }
- /// @b DynamicBuffer_v2: Shrink the underlying memory by the specified number
- /// of bytes.
- /**
- * Erases @c n bytes from the end of the string by resizing the basic_string
- * object. If @c n is greater than the current size of the string, the string
- * is emptied.
- */
- void shrink(std::size_t n)
- {
- string_.resize(n > size() ? 0 : size() - n);
- }
- /// @b DynamicBuffer_v1: Remove characters from the input sequence.
- /// @b DynamicBuffer_v2: Consume the specified number of bytes from the
- /// beginning of the underlying memory.
- /**
- * @b DynamicBuffer_v1: Removes @c n characters from the beginning of the
- * input sequence. @note If @c n is greater than the size of the input
- * sequence, the entire input sequence is consumed and no error is issued.
- *
- * @b DynamicBuffer_v2: Erases @c n bytes from the beginning of the string.
- * If @c n is greater than the current size of the string, the string is
- * emptied.
- */
- void consume(std::size_t n)
- {
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- if (size_ != (std::numeric_limits<std::size_t>::max)())
- {
- std::size_t consume_length = (std::min)(n, size_);
- string_.erase(0, consume_length);
- size_ -= consume_length;
- return;
- }
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- string_.erase(0, n);
- }
- private:
- std::basic_string<Elem, Traits, Allocator>& string_;
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- std::size_t size_;
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- const std::size_t max_size_;
- };
- /// Adapt a vector to the DynamicBuffer requirements.
- /**
- * Requires that <tt>sizeof(Elem) == 1</tt>.
- */
- template <typename Elem, typename Allocator>
- class dynamic_vector_buffer
- {
- public:
- /// The type used to represent a sequence of constant buffers that refers to
- /// the underlying memory.
- typedef BOOST_ASIO_CONST_BUFFER const_buffers_type;
- /// The type used to represent a sequence of mutable buffers that refers to
- /// the underlying memory.
- typedef BOOST_ASIO_MUTABLE_BUFFER mutable_buffers_type;
- /// Construct a dynamic buffer from a vector.
- /**
- * @param v The vector to be used as backing storage for the dynamic buffer.
- * The object stores a reference to the vector and the user is responsible
- * for ensuring that the vector object remains valid while the
- * dynamic_vector_buffer object, and copies of the object, are in use.
- *
- * @param maximum_size Specifies a maximum size for the buffer, in bytes.
- */
- explicit dynamic_vector_buffer(std::vector<Elem, Allocator>& v,
- std::size_t maximum_size =
- (std::numeric_limits<std::size_t>::max)()) noexcept
- : vector_(v),
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- size_((std::numeric_limits<std::size_t>::max)()),
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- max_size_(maximum_size)
- {
- }
- /// @b DynamicBuffer_v2: Copy construct a dynamic buffer.
- dynamic_vector_buffer(const dynamic_vector_buffer& other) noexcept
- : vector_(other.vector_),
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- size_(other.size_),
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- max_size_(other.max_size_)
- {
- }
- /// Move construct a dynamic buffer.
- dynamic_vector_buffer(dynamic_vector_buffer&& other) noexcept
- : vector_(other.vector_),
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- size_(other.size_),
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- max_size_(other.max_size_)
- {
- }
- /// @b DynamicBuffer_v1: Get the size of the input sequence.
- /// @b DynamicBuffer_v2: Get the current size of the underlying memory.
- /**
- * @returns @b DynamicBuffer_v1 The current size of the input sequence.
- * @b DynamicBuffer_v2: The current size of the underlying vector if less than
- * max_size(). Otherwise returns max_size().
- */
- std::size_t size() const noexcept
- {
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- if (size_ != (std::numeric_limits<std::size_t>::max)())
- return size_;
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- return (std::min)(vector_.size(), max_size());
- }
- /// Get the maximum size of the dynamic buffer.
- /**
- * @returns @b DynamicBuffer_v1: The allowed maximum of the sum of the sizes
- * of the input sequence and output sequence. @b DynamicBuffer_v2: The allowed
- * maximum size of the underlying memory.
- */
- std::size_t max_size() const noexcept
- {
- return max_size_;
- }
- /// Get the maximum size that the buffer may grow to without triggering
- /// reallocation.
- /**
- * @returns @b DynamicBuffer_v1: The current total capacity of the buffer,
- * i.e. for both the input sequence and output sequence. @b DynamicBuffer_v2:
- * The current capacity of the underlying vector if less than max_size().
- * Otherwise returns max_size().
- */
- std::size_t capacity() const noexcept
- {
- return (std::min)(vector_.capacity(), max_size());
- }
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// @b DynamicBuffer_v1: Get a list of buffers that represents the input
- /// sequence.
- /**
- * @returns An object of type @c const_buffers_type that satisfies
- * ConstBufferSequence requirements, representing the vector memory in the
- * input sequence.
- *
- * @note The returned object is invalidated by any @c dynamic_vector_buffer
- * or @c vector member function that modifies the input sequence or output
- * sequence.
- */
- const_buffers_type data() const noexcept
- {
- return const_buffers_type(boost::asio::buffer(vector_, size_));
- }
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// @b DynamicBuffer_v2: Get a sequence of buffers that represents the
- /// underlying memory.
- /**
- * @param pos Position of the first byte to represent in the buffer sequence
- *
- * @param n The number of bytes to return in the buffer sequence. If the
- * underlying memory is shorter, the buffer sequence represents as many bytes
- * as are available.
- *
- * @returns An object of type @c mutable_buffers_type that satisfies
- * MutableBufferSequence requirements, representing the vector memory.
- *
- * @note The returned object is invalidated by any @c dynamic_vector_buffer
- * or @c vector member function that resizes or erases the vector.
- */
- mutable_buffers_type data(std::size_t pos, std::size_t n) noexcept
- {
- return mutable_buffers_type(boost::asio::buffer(
- boost::asio::buffer(vector_, max_size_) + pos, n));
- }
- /// @b DynamicBuffer_v2: Get a sequence of buffers that represents the
- /// underlying memory.
- /**
- * @param pos Position of the first byte to represent in the buffer sequence
- *
- * @param n The number of bytes to return in the buffer sequence. If the
- * underlying memory is shorter, the buffer sequence represents as many bytes
- * as are available.
- *
- * @note The returned object is invalidated by any @c dynamic_vector_buffer
- * or @c vector member function that resizes or erases the vector.
- */
- const_buffers_type data(std::size_t pos,
- std::size_t n) const noexcept
- {
- return const_buffers_type(boost::asio::buffer(
- boost::asio::buffer(vector_, max_size_) + pos, n));
- }
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// @b DynamicBuffer_v1: Get a list of buffers that represents the output
- /// sequence, with the given size.
- /**
- * Ensures that the output sequence can accommodate @c n bytes, resizing the
- * vector object as necessary.
- *
- * @returns An object of type @c mutable_buffers_type that satisfies
- * MutableBufferSequence requirements, representing vector memory at the
- * start of the output sequence of size @c n.
- *
- * @throws std::length_error If <tt>size() + n > max_size()</tt>.
- *
- * @note The returned object is invalidated by any @c dynamic_vector_buffer
- * or @c vector member function that modifies the input sequence or output
- * sequence.
- */
- mutable_buffers_type prepare(std::size_t n)
- {
- if (size () > max_size() || max_size() - size() < n)
- {
- std::length_error ex("dynamic_vector_buffer too long");
- boost::asio::detail::throw_exception(ex);
- }
- if (size_ == (std::numeric_limits<std::size_t>::max)())
- size_ = vector_.size(); // Enable v1 behaviour.
- vector_.resize(size_ + n);
- return boost::asio::buffer(boost::asio::buffer(vector_) + size_, n);
- }
- /// @b DynamicBuffer_v1: Move bytes from the output sequence to the input
- /// sequence.
- /**
- * @param n The number of bytes to append from the start of the output
- * sequence to the end of the input sequence. The remainder of the output
- * sequence is discarded.
- *
- * Requires a preceding call <tt>prepare(x)</tt> where <tt>x >= n</tt>, and
- * no intervening operations that modify the input or output sequence.
- *
- * @note If @c n is greater than the size of the output sequence, the entire
- * output sequence is moved to the input sequence and no error is issued.
- */
- void commit(std::size_t n)
- {
- size_ += (std::min)(n, vector_.size() - size_);
- vector_.resize(size_);
- }
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// @b DynamicBuffer_v2: Grow the underlying memory by the specified number of
- /// bytes.
- /**
- * Resizes the vector to accommodate an additional @c n bytes at the end.
- *
- * @throws std::length_error If <tt>size() + n > max_size()</tt>.
- */
- void grow(std::size_t n)
- {
- if (size() > max_size() || max_size() - size() < n)
- {
- std::length_error ex("dynamic_vector_buffer too long");
- boost::asio::detail::throw_exception(ex);
- }
- vector_.resize(size() + n);
- }
- /// @b DynamicBuffer_v2: Shrink the underlying memory by the specified number
- /// of bytes.
- /**
- * Erases @c n bytes from the end of the vector by resizing the vector
- * object. If @c n is greater than the current size of the vector, the vector
- * is emptied.
- */
- void shrink(std::size_t n)
- {
- vector_.resize(n > size() ? 0 : size() - n);
- }
- /// @b DynamicBuffer_v1: Remove characters from the input sequence.
- /// @b DynamicBuffer_v2: Consume the specified number of bytes from the
- /// beginning of the underlying memory.
- /**
- * @b DynamicBuffer_v1: Removes @c n characters from the beginning of the
- * input sequence. @note If @c n is greater than the size of the input
- * sequence, the entire input sequence is consumed and no error is issued.
- *
- * @b DynamicBuffer_v2: Erases @c n bytes from the beginning of the vector.
- * If @c n is greater than the current size of the vector, the vector is
- * emptied.
- */
- void consume(std::size_t n)
- {
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- if (size_ != (std::numeric_limits<std::size_t>::max)())
- {
- std::size_t consume_length = (std::min)(n, size_);
- vector_.erase(vector_.begin(), vector_.begin() + consume_length);
- size_ -= consume_length;
- return;
- }
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- vector_.erase(vector_.begin(), vector_.begin() + (std::min)(size(), n));
- }
- private:
- std::vector<Elem, Allocator>& vector_;
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- std::size_t size_;
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- const std::size_t max_size_;
- };
- /** @defgroup dynamic_buffer boost::asio::dynamic_buffer
- *
- * @brief The boost::asio::dynamic_buffer function is used to create a
- * dynamically resized buffer from a @c std::basic_string or @c std::vector.
- */
- /*@{*/
- /// Create a new dynamic buffer that represents the given string.
- /**
- * @returns <tt>dynamic_string_buffer<Elem, Traits, Allocator>(data)</tt>.
- */
- template <typename Elem, typename Traits, typename Allocator>
- BOOST_ASIO_NODISCARD inline
- dynamic_string_buffer<Elem, Traits, Allocator> dynamic_buffer(
- std::basic_string<Elem, Traits, Allocator>& data) noexcept
- {
- return dynamic_string_buffer<Elem, Traits, Allocator>(data);
- }
- /// Create a new dynamic buffer that represents the given string.
- /**
- * @returns <tt>dynamic_string_buffer<Elem, Traits, Allocator>(data,
- * max_size)</tt>.
- */
- template <typename Elem, typename Traits, typename Allocator>
- BOOST_ASIO_NODISCARD inline
- dynamic_string_buffer<Elem, Traits, Allocator> dynamic_buffer(
- std::basic_string<Elem, Traits, Allocator>& data,
- std::size_t max_size) noexcept
- {
- return dynamic_string_buffer<Elem, Traits, Allocator>(data, max_size);
- }
- /// Create a new dynamic buffer that represents the given vector.
- /**
- * @returns <tt>dynamic_vector_buffer<Elem, Allocator>(data)</tt>.
- */
- template <typename Elem, typename Allocator>
- BOOST_ASIO_NODISCARD inline
- dynamic_vector_buffer<Elem, Allocator> dynamic_buffer(
- std::vector<Elem, Allocator>& data) noexcept
- {
- return dynamic_vector_buffer<Elem, Allocator>(data);
- }
- /// Create a new dynamic buffer that represents the given vector.
- /**
- * @returns <tt>dynamic_vector_buffer<Elem, Allocator>(data, max_size)</tt>.
- */
- template <typename Elem, typename Allocator>
- BOOST_ASIO_NODISCARD inline
- dynamic_vector_buffer<Elem, Allocator> dynamic_buffer(
- std::vector<Elem, Allocator>& data,
- std::size_t max_size) noexcept
- {
- return dynamic_vector_buffer<Elem, Allocator>(data, max_size);
- }
- /*@}*/
- /** @defgroup buffer_copy boost::asio::buffer_copy
- *
- * @brief The boost::asio::buffer_copy function is used to copy bytes from a
- * source buffer (or buffer sequence) to a target buffer (or buffer sequence).
- *
- * The @c buffer_copy function is available in two forms:
- *
- * @li A 2-argument form: @c buffer_copy(target, source)
- *
- * @li A 3-argument form: @c buffer_copy(target, source, max_bytes_to_copy)
- *
- * Both forms return the number of bytes actually copied. The number of bytes
- * copied is the lesser of:
- *
- * @li @c buffer_size(target)
- *
- * @li @c buffer_size(source)
- *
- * @li @c If specified, @c max_bytes_to_copy.
- *
- * This prevents buffer overflow, regardless of the buffer sizes used in the
- * copy operation.
- *
- * Note that @ref buffer_copy is implemented in terms of @c memcpy, and
- * consequently it cannot be used to copy between overlapping memory regions.
- */
- /*@{*/
- namespace detail {
- inline std::size_t buffer_copy_1(const mutable_buffer& target,
- const const_buffer& source)
- {
- using namespace std; // For memcpy.
- std::size_t target_size = target.size();
- std::size_t source_size = source.size();
- std::size_t n = target_size < source_size ? target_size : source_size;
- if (n > 0)
- memcpy(target.data(), source.data(), n);
- return n;
- }
- template <typename TargetIterator, typename SourceIterator>
- inline std::size_t buffer_copy(one_buffer, one_buffer,
- TargetIterator target_begin, TargetIterator,
- SourceIterator source_begin, SourceIterator) noexcept
- {
- return (buffer_copy_1)(*target_begin, *source_begin);
- }
- template <typename TargetIterator, typename SourceIterator>
- inline std::size_t buffer_copy(one_buffer, one_buffer,
- TargetIterator target_begin, TargetIterator,
- SourceIterator source_begin, SourceIterator,
- std::size_t max_bytes_to_copy) noexcept
- {
- return (buffer_copy_1)(*target_begin,
- boost::asio::buffer(*source_begin, max_bytes_to_copy));
- }
- template <typename TargetIterator, typename SourceIterator>
- std::size_t buffer_copy(one_buffer, multiple_buffers,
- TargetIterator target_begin, TargetIterator,
- SourceIterator source_begin, SourceIterator source_end,
- std::size_t max_bytes_to_copy
- = (std::numeric_limits<std::size_t>::max)()) noexcept
- {
- std::size_t total_bytes_copied = 0;
- SourceIterator source_iter = source_begin;
- for (mutable_buffer target_buffer(
- boost::asio::buffer(*target_begin, max_bytes_to_copy));
- target_buffer.size() && source_iter != source_end; ++source_iter)
- {
- const_buffer source_buffer(*source_iter);
- std::size_t bytes_copied = (buffer_copy_1)(target_buffer, source_buffer);
- total_bytes_copied += bytes_copied;
- target_buffer += bytes_copied;
- }
- return total_bytes_copied;
- }
- template <typename TargetIterator, typename SourceIterator>
- std::size_t buffer_copy(multiple_buffers, one_buffer,
- TargetIterator target_begin, TargetIterator target_end,
- SourceIterator source_begin, SourceIterator,
- std::size_t max_bytes_to_copy
- = (std::numeric_limits<std::size_t>::max)()) noexcept
- {
- std::size_t total_bytes_copied = 0;
- TargetIterator target_iter = target_begin;
- for (const_buffer source_buffer(
- boost::asio::buffer(*source_begin, max_bytes_to_copy));
- source_buffer.size() && target_iter != target_end; ++target_iter)
- {
- mutable_buffer target_buffer(*target_iter);
- std::size_t bytes_copied = (buffer_copy_1)(target_buffer, source_buffer);
- total_bytes_copied += bytes_copied;
- source_buffer += bytes_copied;
- }
- return total_bytes_copied;
- }
- template <typename TargetIterator, typename SourceIterator>
- std::size_t buffer_copy(multiple_buffers, multiple_buffers,
- TargetIterator target_begin, TargetIterator target_end,
- SourceIterator source_begin, SourceIterator source_end) noexcept
- {
- std::size_t total_bytes_copied = 0;
- TargetIterator target_iter = target_begin;
- std::size_t target_buffer_offset = 0;
- SourceIterator source_iter = source_begin;
- std::size_t source_buffer_offset = 0;
- while (target_iter != target_end && source_iter != source_end)
- {
- mutable_buffer target_buffer =
- mutable_buffer(*target_iter) + target_buffer_offset;
- const_buffer source_buffer =
- const_buffer(*source_iter) + source_buffer_offset;
- std::size_t bytes_copied = (buffer_copy_1)(target_buffer, source_buffer);
- total_bytes_copied += bytes_copied;
- if (bytes_copied == target_buffer.size())
- {
- ++target_iter;
- target_buffer_offset = 0;
- }
- else
- target_buffer_offset += bytes_copied;
- if (bytes_copied == source_buffer.size())
- {
- ++source_iter;
- source_buffer_offset = 0;
- }
- else
- source_buffer_offset += bytes_copied;
- }
- return total_bytes_copied;
- }
- template <typename TargetIterator, typename SourceIterator>
- std::size_t buffer_copy(multiple_buffers, multiple_buffers,
- TargetIterator target_begin, TargetIterator target_end,
- SourceIterator source_begin, SourceIterator source_end,
- std::size_t max_bytes_to_copy) noexcept
- {
- std::size_t total_bytes_copied = 0;
- TargetIterator target_iter = target_begin;
- std::size_t target_buffer_offset = 0;
- SourceIterator source_iter = source_begin;
- std::size_t source_buffer_offset = 0;
- while (total_bytes_copied != max_bytes_to_copy
- && target_iter != target_end && source_iter != source_end)
- {
- mutable_buffer target_buffer =
- mutable_buffer(*target_iter) + target_buffer_offset;
- const_buffer source_buffer =
- const_buffer(*source_iter) + source_buffer_offset;
- std::size_t bytes_copied = (buffer_copy_1)(
- target_buffer, boost::asio::buffer(source_buffer,
- max_bytes_to_copy - total_bytes_copied));
- total_bytes_copied += bytes_copied;
- if (bytes_copied == target_buffer.size())
- {
- ++target_iter;
- target_buffer_offset = 0;
- }
- else
- target_buffer_offset += bytes_copied;
- if (bytes_copied == source_buffer.size())
- {
- ++source_iter;
- source_buffer_offset = 0;
- }
- else
- source_buffer_offset += bytes_copied;
- }
- return total_bytes_copied;
- }
- } // namespace detail
- /// Copies bytes from a source buffer sequence to a target buffer sequence.
- /**
- * @param target A modifiable buffer sequence representing the memory regions to
- * which the bytes will be copied.
- *
- * @param source A non-modifiable buffer sequence representing the memory
- * regions from which the bytes will be copied.
- *
- * @returns The number of bytes copied.
- *
- * @note The number of bytes copied is the lesser of:
- *
- * @li @c buffer_size(target)
- *
- * @li @c buffer_size(source)
- *
- * This function is implemented in terms of @c memcpy, and consequently it
- * cannot be used to copy between overlapping memory regions.
- */
- template <typename MutableBufferSequence, typename ConstBufferSequence>
- inline std::size_t buffer_copy(const MutableBufferSequence& target,
- const ConstBufferSequence& source) noexcept
- {
- return detail::buffer_copy(
- detail::buffer_sequence_cardinality<MutableBufferSequence>(),
- detail::buffer_sequence_cardinality<ConstBufferSequence>(),
- boost::asio::buffer_sequence_begin(target),
- boost::asio::buffer_sequence_end(target),
- boost::asio::buffer_sequence_begin(source),
- boost::asio::buffer_sequence_end(source));
- }
- /// Copies a limited number of bytes from a source buffer sequence to a target
- /// buffer sequence.
- /**
- * @param target A modifiable buffer sequence representing the memory regions to
- * which the bytes will be copied.
- *
- * @param source A non-modifiable buffer sequence representing the memory
- * regions from which the bytes will be copied.
- *
- * @param max_bytes_to_copy The maximum number of bytes to be copied.
- *
- * @returns The number of bytes copied.
- *
- * @note The number of bytes copied is the lesser of:
- *
- * @li @c buffer_size(target)
- *
- * @li @c buffer_size(source)
- *
- * @li @c max_bytes_to_copy
- *
- * This function is implemented in terms of @c memcpy, and consequently it
- * cannot be used to copy between overlapping memory regions.
- */
- template <typename MutableBufferSequence, typename ConstBufferSequence>
- inline std::size_t buffer_copy(const MutableBufferSequence& target,
- const ConstBufferSequence& source,
- std::size_t max_bytes_to_copy) noexcept
- {
- return detail::buffer_copy(
- detail::buffer_sequence_cardinality<MutableBufferSequence>(),
- detail::buffer_sequence_cardinality<ConstBufferSequence>(),
- boost::asio::buffer_sequence_begin(target),
- boost::asio::buffer_sequence_end(target),
- boost::asio::buffer_sequence_begin(source),
- boost::asio::buffer_sequence_end(source), max_bytes_to_copy);
- }
- /*@}*/
- } // namespace asio
- } // namespace boost
- #include <boost/asio/detail/pop_options.hpp>
- #include <boost/asio/detail/is_buffer_sequence.hpp>
- #include <boost/asio/detail/push_options.hpp>
- namespace boost {
- namespace asio {
- /// Trait to determine whether a type satisfies the MutableBufferSequence
- /// requirements.
- template <typename T>
- struct is_mutable_buffer_sequence
- #if defined(GENERATING_DOCUMENTATION)
- : integral_constant<bool, automatically_determined>
- #else // defined(GENERATING_DOCUMENTATION)
- : boost::asio::detail::is_buffer_sequence<T, mutable_buffer>
- #endif // defined(GENERATING_DOCUMENTATION)
- {
- };
- /// Trait to determine whether a type satisfies the ConstBufferSequence
- /// requirements.
- template <typename T>
- struct is_const_buffer_sequence
- #if defined(GENERATING_DOCUMENTATION)
- : integral_constant<bool, automatically_determined>
- #else // defined(GENERATING_DOCUMENTATION)
- : boost::asio::detail::is_buffer_sequence<T, const_buffer>
- #endif // defined(GENERATING_DOCUMENTATION)
- {
- };
- #if !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// Trait to determine whether a type satisfies the DynamicBuffer_v1
- /// requirements.
- template <typename T>
- struct is_dynamic_buffer_v1
- #if defined(GENERATING_DOCUMENTATION)
- : integral_constant<bool, automatically_determined>
- #else // defined(GENERATING_DOCUMENTATION)
- : boost::asio::detail::is_dynamic_buffer_v1<T>
- #endif // defined(GENERATING_DOCUMENTATION)
- {
- };
- #endif // !defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- /// Trait to determine whether a type satisfies the DynamicBuffer_v2
- /// requirements.
- template <typename T>
- struct is_dynamic_buffer_v2
- #if defined(GENERATING_DOCUMENTATION)
- : integral_constant<bool, automatically_determined>
- #else // defined(GENERATING_DOCUMENTATION)
- : boost::asio::detail::is_dynamic_buffer_v2<T>
- #endif // defined(GENERATING_DOCUMENTATION)
- {
- };
- /// Trait to determine whether a type satisfies the DynamicBuffer requirements.
- /**
- * If @c BOOST_ASIO_NO_DYNAMIC_BUFFER_V1 is not defined, determines whether the
- * type satisfies the DynamicBuffer_v1 requirements. Otherwise, if @c
- * BOOST_ASIO_NO_DYNAMIC_BUFFER_V1 is defined, determines whether the type
- * satisfies the DynamicBuffer_v2 requirements.
- */
- template <typename T>
- struct is_dynamic_buffer
- #if defined(GENERATING_DOCUMENTATION)
- : integral_constant<bool, automatically_determined>
- #elif defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- : boost::asio::is_dynamic_buffer_v2<T>
- #else // defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- : boost::asio::is_dynamic_buffer_v1<T>
- #endif // defined(BOOST_ASIO_NO_DYNAMIC_BUFFER_V1)
- {
- };
- namespace buffer_literals {
- namespace detail {
- template <char... Chars>
- struct chars {};
- template <unsigned char... Bytes>
- struct bytes {};
- // Literal processor that converts binary literals to an array of bytes.
- template <typename Bytes, char... Chars>
- struct bin_literal;
- template <unsigned char... Bytes>
- struct bin_literal<bytes<Bytes...>>
- {
- static const std::size_t size = sizeof...(Bytes);
- static const unsigned char data[sizeof...(Bytes)];
- };
- template <unsigned char... Bytes>
- const unsigned char bin_literal<bytes<Bytes...>>::data[sizeof...(Bytes)]
- = { Bytes... };
- template <unsigned char... Bytes, char Bit7, char Bit6, char Bit5,
- char Bit4, char Bit3, char Bit2, char Bit1, char Bit0, char... Chars>
- struct bin_literal<bytes<Bytes...>, Bit7, Bit6,
- Bit5, Bit4, Bit3, Bit2, Bit1, Bit0, Chars...> :
- bin_literal<
- bytes<Bytes...,
- static_cast<unsigned char>(
- (Bit7 == '1' ? 0x80 : 0) |
- (Bit6 == '1' ? 0x40 : 0) |
- (Bit5 == '1' ? 0x20 : 0) |
- (Bit4 == '1' ? 0x10 : 0) |
- (Bit3 == '1' ? 0x08 : 0) |
- (Bit2 == '1' ? 0x04 : 0) |
- (Bit1 == '1' ? 0x02 : 0) |
- (Bit0 == '1' ? 0x01 : 0))
- >, Chars...> {};
- template <unsigned char... Bytes, char... Chars>
- struct bin_literal<bytes<Bytes...>, Chars...>
- {
- static_assert(sizeof...(Chars) == 0,
- "number of digits in a binary buffer literal must be a multiple of 8");
- static const std::size_t size = 0;
- static const unsigned char data[1];
- };
- template <unsigned char... Bytes, char... Chars>
- const unsigned char bin_literal<bytes<Bytes...>, Chars...>::data[1] = {};
- // Literal processor that converts hexadecimal literals to an array of bytes.
- template <typename Bytes, char... Chars>
- struct hex_literal;
- template <unsigned char... Bytes>
- struct hex_literal<bytes<Bytes...>>
- {
- static const std::size_t size = sizeof...(Bytes);
- static const unsigned char data[sizeof...(Bytes)];
- };
- template <unsigned char... Bytes>
- const unsigned char hex_literal<bytes<Bytes...>>::data[sizeof...(Bytes)]
- = { Bytes... };
- template <unsigned char... Bytes, char Hi, char Lo, char... Chars>
- struct hex_literal<bytes<Bytes...>, Hi, Lo, Chars...> :
- hex_literal<
- bytes<Bytes...,
- static_cast<unsigned char>(
- Lo >= 'A' && Lo <= 'F' ? Lo - 'A' + 10 :
- (Lo >= 'a' && Lo <= 'f' ? Lo - 'a' + 10 : Lo - '0')) |
- ((static_cast<unsigned char>(
- Hi >= 'A' && Hi <= 'F' ? Hi - 'A' + 10 :
- (Hi >= 'a' && Hi <= 'f' ? Hi - 'a' + 10 : Hi - '0'))) << 4)
- >, Chars...> {};
- template <unsigned char... Bytes, char Char>
- struct hex_literal<bytes<Bytes...>, Char>
- {
- static_assert(!Char,
- "a hexadecimal buffer literal must have an even number of digits");
- static const std::size_t size = 0;
- static const unsigned char data[1];
- };
- template <unsigned char... Bytes, char Char>
- const unsigned char hex_literal<bytes<Bytes...>, Char>::data[1] = {};
- // Helper template that removes digit separators and then passes the cleaned
- // variadic pack of characters to the literal processor.
- template <template <typename, char...> class Literal,
- typename Clean, char... Raw>
- struct remove_separators;
- template <template <typename, char...> class Literal,
- char... Clean, char... Raw>
- struct remove_separators<Literal, chars<Clean...>, '\'', Raw...> :
- remove_separators<Literal, chars<Clean...>, Raw...> {};
- template <template <typename, char...> class Literal,
- char... Clean, char C, char... Raw>
- struct remove_separators<Literal, chars<Clean...>, C, Raw...> :
- remove_separators<Literal, chars<Clean..., C>, Raw...> {};
- template <template <typename, char...> class Literal, char... Clean>
- struct remove_separators<Literal, chars<Clean...>> :
- Literal<bytes<>, Clean...> {};
- // Helper template to determine the literal type based on the prefix.
- template <char... Chars>
- struct literal;
- template <char... Chars>
- struct literal<'0', 'b', Chars...> :
- remove_separators<bin_literal, chars<>, Chars...>{};
- template <char... Chars>
- struct literal<'0', 'B', Chars...> :
- remove_separators<bin_literal, chars<>, Chars...>{};
- template <char... Chars>
- struct literal<'0', 'x', Chars...> :
- remove_separators<hex_literal, chars<>, Chars...>{};
- template <char... Chars>
- struct literal<'0', 'X', Chars...> :
- remove_separators<hex_literal, chars<>, Chars...>{};
- } // namespace detail
- /// Literal operator for creating const_buffer objects from string literals.
- inline BOOST_ASIO_CONST_BUFFER operator ""_buf(const char* data, std::size_t n)
- {
- return BOOST_ASIO_CONST_BUFFER(data, n);
- }
- /// Literal operator for creating const_buffer objects from unbounded binary or
- /// hexadecimal integer literals.
- template <char... Chars>
- inline BOOST_ASIO_CONST_BUFFER operator ""_buf()
- {
- return BOOST_ASIO_CONST_BUFFER(
- +detail::literal<Chars...>::data,
- detail::literal<Chars...>::size);
- }
- } // namespace buffer_literals
- } // namespace asio
- } // namespace boost
- #include <boost/asio/detail/pop_options.hpp>
- #endif // BOOST_ASIO_BUFFER_HPP
|