[#BloombergLP-bdlsb-FixedMemInput]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlsb.adoc[bdlsb]::FixedMemInput
:relfileprefix: ../../
:mrdocs:

This class, like `bdlsb::FixedMemInStreamBuf`, implements the input functionality of the `basic_streambuf` interface, using client‐supplied `char *` memory. It has an interface identical to `bdlsb::FixedMemInStreamBuf` but does _not_ inherit from `bsl::streambuf`. This implementation is advantageous for performance reasons, as the overhead of the initialization and virtual function calls of a `bsl::streambuf` can be undesirable. It is especially designed for streaming a very small amount of information from a fixed‐length buffer using a `bslx_genericinstream` when the number of characters read from the input is guaranteed not to exceed the length of the buffer. Note that this class is not designed to be derived from.

== Synopsis

Declared in `<bdlsb_fixedmeminput.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class FixedMemInput;
----

== Type Aliases

[cols="1"]
|===
| Name
| xref:BloombergLP/bdlsb/FixedMemInput/char_type.adoc[`char_type`] 
| xref:BloombergLP/bdlsb/FixedMemInput/int_type.adoc[`int_type`] 
| xref:BloombergLP/bdlsb/FixedMemInput/off_type.adoc[`off_type`] 
| xref:BloombergLP/bdlsb/FixedMemInput/pos_type.adoc[`pos_type`] 
| xref:BloombergLP/bdlsb/FixedMemInput/traits_type.adoc[`traits_type`] 
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlsb/FixedMemInput/2constructor.adoc[`FixedMemInput`]         [.small]#[constructor]#
| Create a `FixedMemInput` using the specified `buffer` of the specified `length`. The position indicator is set to the beginning of the `buffer`. The behavior is undefined unless `buffer != 0 && length > 0` or `length == 0`. Note that `buffer` is held but not owned.
| xref:BloombergLP/bdlsb/FixedMemInput/capacity.adoc[`capacity`] 
| Return the size for the buffer held by this buffer, in bytes, supplied at construction.
| xref:BloombergLP/bdlsb/FixedMemInput/data.adoc[`data`] 
| Return the address of the non‐modifiable character buffer held by this stream buffer.
| xref:BloombergLP/bdlsb/FixedMemInput/in_avail.adoc[`in_avail`] 
| Return the number of characters available from the current read position in this stream buffer.
| xref:BloombergLP/bdlsb/FixedMemInput/length.adoc[`length`] 
| Return the number of characters that can be successfully read from this stream buffer before reading `traits_type::eof()` ‐‐ i.e., the number of characters between the current read position and the end of this buffer.
| xref:BloombergLP/bdlsb/FixedMemInput/pubseekoff.adoc[`pubseekoff`] 
| Set the position indicator to the relative specified `offset` from the base position indicated by the specified `way` and return the resulting absolute position on success or pos_type(‐1) on failure. Optionally specify `which` area of the stream buffer. The seek operation will fail if `which` does not include the flag `bsl::ios_base::in` or if the resulting absolute position is less than zero or greater than the value returned by `length`.
| xref:BloombergLP/bdlsb/FixedMemInput/pubseekpos.adoc[`pubseekpos`] 
| Set the position indicator to the specified `position` and return the resulting absolute position on success or pos_type(‐1) on failure. Optionally specify `which` area of the stream buffer. The `seekpos` operation will fail if `which` does not include the flag `bsl::ios_base::in` or if position is less then zero or greater than the value returned by `length`.
| xref:BloombergLP/bdlsb/FixedMemInput/pubsetbuf.adoc[`pubsetbuf`] 
| Reinitialize this stream buffer to use the specified character `buffer` having the specified `length`. Return a pointer providing modifiable access to this stream buffer. The behaviour is undefined unless `buffer != 0 && length > 0` or `length == 0`. Upon reinitialization for use of the new buffer, the position indicator is set to the beginning of the `buffer`. Note that `buffer` is held but not owned.
| xref:BloombergLP/bdlsb/FixedMemInput/sbumpc.adoc[`sbumpc`] 
| Return the character at the current read position from this buffer, or `traits_type::eof()` if the end of the buffer is reached and advance read position indicator.
| xref:BloombergLP/bdlsb/FixedMemInput/sgetc.adoc[`sgetc`] 
| Return the character at the current read position from this buffer, or `traits_type::eof()` if the end of the buffer is reached.
| xref:BloombergLP/bdlsb/FixedMemInput/sgetn.adoc[`sgetn`] 
| Read the specified `length` characters to the specified `destination`. Return the number of characters successfully read from this buffer, which is either equal to the `length` parameter or equal to the distance from the current read position to the end of the input buffer, whichever is smaller, and move the read cursor position by this amount. The behavior is undefined unless '0 <= length'.
| xref:BloombergLP/bdlsb/FixedMemInput/snextc.adoc[`snextc`] 
| Advance the current read position and return the character at the resulting position from this buffer, or `traits_type::eof()` if the end of the buffer is reached.
| xref:BloombergLP/bdlsb/FixedMemInput/sputbackc.adoc[`sputbackc`] 
| Move the current read position back one character if the current read position is not at the beginning of the buffer and the previous position contains the specified character `c`, and return that character. Otherwise, return `traits_type::eof()` and do not move the current read position.
| xref:BloombergLP/bdlsb/FixedMemInput/sungetc.adoc[`sungetc`] 
| Move the current read position back one character if the current read position is not at the beginning of the buffer, and return the character at the resulting current read position from this buffer. Return `traits_type::eof()` otherwise.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#