Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/group__Stream.html below:

C++ IOStream Fixups And Utilities

Definition at line 729 of file ncbistre.hpp.

Definition at line 732 of file ncbistre.hpp.

Definition at line 736 of file ncbistre.hpp.

Definition at line 728 of file ncbistre.hpp.

Definition at line 733 of file ncbistre.hpp.

Definition at line 731 of file ncbistre.hpp.

Definition at line 735 of file ncbistre.hpp.

Definition at line 734 of file ncbistre.hpp.

Portable alias for strstreambuf.

Portable alias for istrstream. Portable alias for ostrstream. Portable alias for strstream.

Definition at line 168 of file ncbistre.hpp.

Definition at line 571 of file ncbistre.hpp.

Definition at line 544 of file ncbistre.hpp.

Definition at line 542 of file ncbistre.hpp.

Definition at line 545 of file ncbistre.hpp.

Definition at line 543 of file ncbistre.hpp.

Definition at line 552 of file ncbistre.hpp.

Definition at line 548 of file ncbistre.hpp.

Definition at line 549 of file ncbistre.hpp.

Definition at line 569 of file ncbistre.hpp.

Definition at line 570 of file ncbistre.hpp.

Definition at line 557 of file ncbistre.hpp.

Definition at line 550 of file ncbistre.hpp.

Definition at line 568 of file ncbistre.hpp.

Definition at line 572 of file ncbistre.hpp.

Definition at line 554 of file ncbistre.hpp.

Definition at line 561 of file ncbistre.hpp.

Definition at line 558 of file ncbistre.hpp.

Definition at line 560 of file ncbistre.hpp.

Definition at line 563 of file ncbistre.hpp.

Definition at line 562 of file ncbistre.hpp.

Definition at line 564 of file ncbistre.hpp.

Definition at line 565 of file ncbistre.hpp.

template<typename _Base , IOS_BASE::openmode _DefMode>

Definition at line 243 of file ncbistre.hpp.

template<typename _Base , IOS_BASE::openmode _DefMode>

template<class T >

Definition at line 254 of file ncbistre.hpp.

Whether to discard BOM or to keep it in the input stream.

See also

GetTextEncodingForm

Discard the read BOM bytes.

Push the read BOM bytes back into the input stream.

Definition at line 1056 of file ncbistre.hpp.

Mode to compare streams in text form.

Skip end-of-line characters ('\r' and '
')

Skip white spaces (in terms of isspace(), including end-of-line)

Definition at line 686 of file ncbistre.hpp.

Helper functions to read plain-text data streams.

It understands Byte Order Mark (BOM) and converts the input if needed.

See clause 13.6 in http://www.unicode.org/unicode/uni2book/ch13.pdf and also http://unicode.org/faq/utf_bom.html#BOM

See also

ReadIntoUtf8, GetTextEncodingForm

Stream has no BOM.

Stream has no BOM.

Stream has no BOM.

Stream has UTF8 BOM.

Stream has UTF16 BOM. Byte order is native for this OS.

Stream has UTF16 BOM. Byte order is nonnative for this OS.

Definition at line 994 of file ncbistre.hpp.

Definition at line 125 of file stream_utils.hpp.

How to read the text if the encoding form is not known (i.e.

passed "eEncodingForm_Unknown" and the stream does not have BOM too)

See also

ReadIntoUtf8

Read the text "as is" (raw octal data).

The read data can then be accessed using the regular std::string API (rather than the CStringUTF8 one).

Try to guess the text's encoding form.

Note

In this case the encoding is a guesswork, which is not necessarily correct. If the guess is wrong then the data may be distorted on read. Use CStringUTF8::IsValid() to verify that guess. If it does not verify, then the read data can be accessed using the regular std::string API (rather than the CStringUTF8 one).

Definition at line 1014 of file ncbistre.hpp.

Result codes for I/O operations.

Note

Exceptions (if any) thrown by IReader/IWriter interfaces should be treated as unrecoverable errors (eRW_Error).

See also

IReader, IWriter, IReaderWriter

Action / information is not available.

Everything is okay, I/O completed.

Timeout expired, try again later.

Unrecoverable error, no retry possible.

End of data, should be considered permanent.

Definition at line 60 of file reader_writer.hpp.

Definition at line 1082 of file ncbistre.hpp.

Definition at line 871 of file ncbistre.hpp.

Definition at line 184 of file ncbistre.hpp.

template<typename TInteger , typename = typename enable_if_integral<TInteger>::type>

Definition at line 193 of file ncbistre.hpp.

Definition at line 179 of file ncbistre.hpp.

template<typename TInteger , typename = typename enable_if_integral<TInteger>::type>

Definition at line 198 of file ncbistre.hpp.

template<typename _Base , IOS_BASE::openmode _DefMode>

template<typename TInteger , typename = typename enable_if_integral<TInteger>::type>

Definition at line 258 of file ncbistre.hpp.

template<typename _Base , IOS_BASE::openmode _DefMode>

Definition at line 244 of file ncbistre.hpp.

Definition at line 896 of file ncbistre.hpp.

Definition at line 889 of file ncbistre.hpp.

Definition at line 851 of file ncbistre.hpp.

Flush pending data (if any) down to the output device.

Implemented in COSSWriter, CBufferWriter< TBuffer >, CBufferWriter< Buffer >, CxBlobWriter, CBDB_CacheIWriter, CNetCacheWriter, CCgiStreamWrapperWriter, COSSWriter, COSSWriter, CTransmissionWriter, CMultiWriter, CChecksumStreamWriter, CBufferWriter< TBuffer >, CBufferWriter< Buffer >, COctetStringSequenceWriter, CWriter_HTMLEncoder, CBlobWriter, CBDB_BlobReaderWriter, CStreamWriter, CFileReaderWriter, CFileWriter, CSocketReaderWriter, NDirectNetStorageImpl::CWOFileTrack, NDirectNetStorageImpl::CWONetCache, NDirectNetStorageImpl::CRWNotFound, NDirectNetStorageImpl::CObj, SNetStorageObjectRPC, SNetStorageObjectRPC::SOState, SNetStorage_NetCacheBlob, SNetStorage_NetCacheBlob::SOState, SEmbeddedStreamReaderWriter, SH2S_ReaderWriter, CStringOrWriter, SNetStorageObjectIState, CMD5StreamWriter< Buffer >, and CNullWriter.

Referenced by SEmbeddedStreamReaderWriter::Flush(), CTransmissionWriter::Flush(), CRWStreambuf::overflow(), and CSegmentSmearGlyph::CSegMap::Serialize().

Detect if the stream has BOM.

Parameters

input Input stream discard_bom Whether to discard the read BOM bytes or to push them back to the stream

NOTE: If the function needs to push back more than one char then it uses CStreamUtils::Pushback().

See also

CStreamUtils::Pushback()

Definition at line 782 of file ncbistre.cpp.

References eBOM_Keep, eEncodingForm_Unknown, eEncodingForm_Utf16Foreign, eEncodingForm_Utf16Native, eEncodingForm_Utf8, input(), int, n, CStreamUtils::Pushback(), and tmp.

Referenced by operator>>(), and IRWRegistry::Read().

Definition at line 831 of file ncbistre.hpp.

References GetOssSize().

Referenced by CRemoteCgiJob::Do(), Empty(), CEditingActionFlatFile::Find(), CFlatFileField::GetVal(), CAgpErrEx::LineDone(), CMonitoredProcessWatcher::MonitorRun(), CException::ReportThis(), CMacroFunction_FixSpelling::TheFunction(), CSeqUpdateWorker::x_LaunchSingleUpdateSequence(), CMonitoredProcessWatcher::x_Log(), IMacroFunction< CIRef< IMacroBioDataIter > >::x_LogError(), IMacroFunction< CIRef< IMacroBioDataIter > >::x_LogFunction(), CNcbiDiag::x_Put(), and CUpdateMultiSeq_Dlg::x_UpdateSelected().

Read from "is" to "str" up to the delimiter symbol "delim" (or EOF)

Referenced by CFormatGuess::EnsureStats(), CTableImportDataSource::LoadTable(), MyGetline(), CStreamLineReader::operator++(), CSplitCacheApp::Process(), ProcessStream(), CAgpReader::ReadStream(), COMSSAMerge::Run(), CAgpFastaComparator::Run(), s_GetBigBedFeats(), s_GetBigBedSummary(), CFormatGuess::TestFormatCLUSTAL(), CFormatGuess::TestFormatTextAsn(), CStreamLineReader::x_AdvanceEOLCRLF(), CStreamLineReader::x_AdvanceEOLSimple(), CStreamLineReader::x_AdvanceEOLUnknown(), CCgiEntryReaderContext::x_DelimitedRead(), CWigGraph::x_GetBigWigSummary(), CRegexpTemplateTester::x_GetLine(), CSDB_ConnectionParam::x_GetPassword(), CBlastVdbCmdApp::x_InitApplicationData(), CAgpValidateApplication::x_LoadLenFa(), CHTMLPage::x_LoadTemplateLib(), and CAgpValidateApplication::x_ValidateFile().

Read from "is" to "str" up to any symbol contained within "delims" (or EOF)

Note

Special case – if two different delimiters are back to back and in the same order as in delims, treat them as a single delimiter. E.g. "\r\n" will handle mixed DOS/MAC/UNIX line endings such as "\r", "\n" and "\r\n".

Read from "is" to "str" the next line (taking into account platform specifics of End-of-Line)

Referenced by CLinkUtils::AddSequenceLinks(), AgpRead(), BOOST_AUTO_TEST_CASE(), CDBInterfacesFileConnParams::CDBInterfacesFileConnParams(), CBlastDBAliasApp::ConvertGiFile(), CDumpSysInfo::DumpSystemInfo(), CPhyObjectLoader::Execute(), CWinMaskConfig::FillIdList(), CFeedbackReport::Format(), CCodeGenerator::GenerateCvsignore(), CProjectsLstFileFilter::GetAllowedTagsInfo(), GetIDsFromFile(), Getline(), CTextUtil::GetWordFrequencies(), CProjectsLstFileFilter::InitFromFile(), CIdMapperConfig::Initialize(), CAgpConverter::LoadChromosomeMap(), CProjBulderApp::LoadDepGraph(), CSimpleMakeFileContents::LoadFrom(), CSimpleMakeFileContents::SParser::LoadInclude(), CProjBulderApp::LoadProjectTags(), CWinMaskUtil::CInputBioseq_CI::operator++(), CMakefilePatch::PatchTreeMakefiles(), PromoteIfDifferent(), CDiagErrCodeInfo::Read(), CSimpleDictionary::Read(), CGlimmerReader::Read(), CRepeatLibrary::Read(), CDistanceMatrix::Read(), CColumnarVCFReader::ReadData(), ReadTextFile(), CColumnarVCFReader::ReadVariantsForChrs(), CNcbiApplogApp::Redirect(), CDemoSeqQaApp::Run(), CNcbiApplogApp::Run(), CTax4BlastDemo::Run(), CAsn2FastaApp::Run(), CAsn2FlatApp::Run(), CPubmedFetchApplication::Run(), CAsnCacheTestApplication::Run(), CPrimeCacheApplication::Run(), CAsnSubCacheCreateApplication::Run(), CMytestApplication::Run(), s_CheckSorted(), s_LookForOidlistInAliasFile(), s_ReadIdsFromFile(), s_UpdateVolumesInAliasFile(), CTaxIdSet::SetMappingFromFile(), NuclWordFinderTextFixture::setupSequenceOffsets(), CCodeGenerator::UndoGenerateCode(), CBlastUsageReport::x_CheckRunEnv(), CBlastDBAliasApp::x_ConvertSeqIDFile(), CWigGraph::x_GetBigWigData(), CBlastVdbCmdApp::x_GetQueries(), CMakeProfileDBApp::x_GetSMPFilenames(), CBlastDBCmdApp::x_InitBlastDB_TaxIdList(), CUnicodeToAsciiTranslation::x_Initialize(), CBlastDBCmdApp::x_ProcessBatchEntry(), CBlastDBCmdApp::x_ProcessBatchEntry_NoDup(), CBlastDBCmdApp::x_ProcessBatchPig(), IRWRegistry::x_Read(), CPrimeCacheApplication::x_Read_Ids(), and CBLASTDatabases::x_UpdateDbMap().

Compare stream contents in binary form.

Parameters

is1 First stream to compare. is2 Second stream to compare.

Returns

TRUE if streams content is equal; FALSE otherwise.

Definition at line 356 of file ncbistre.cpp.

Compare stream content with string in text form.

Parameters

is Stream to compare. str String to compare. mode Type of white space characters to ignore. buf_size Size of buffer to read stream. Zero value means using default buffer size.

Returns

TRUE if stream and string content is equal; FALSE otherwise.

Definition at line 419 of file ncbistre.cpp.

References NcbiStreamCompareText(), and str().

Compare stream contents in text form.

Parameters

is1 First stream to compare. is2 Second stream to compare. mode Type of white space characters to ignore. buf_size Size of buffer to read stream. Zero value means using default buffer size.

Returns

TRUE if streams content is equal; FALSE otherwise.

Definition at line 394 of file ncbistre.cpp.

References x_GetChar().

Referenced by CFile::CompareTextContents(), and NcbiStreamCompareText().

Copy the entire contents of stream "is" to stream "os".

Returns

"true" if the operation was successful, i.e. "is" had been read entirely with all of its _available_ contents (including none) written to "os"; "false" if either extraction from "is" or insertion into "os" failed.

The call may throw exceptions only if they are enabled on the respective stream(s).

Note

The call is an extension to the standard ostream& ostream::operator<<(streambuf*), which severely lacks error checking (esp. for partial write failures).

Input ("is") stream state is not always asserted accurately: in particular, upon successful completion "is.eof()" may not necessarily be true; or, in case of fatal read errors "is" may not have its "is.bad()" state set (however, the return code should still be "false" to properly indicate the copy failure in this case).

Attention

This call (as well as the mentioned STL counterpart) provides only the mechanism of delivering data to the destination stream(buf) "os"; and a successful return result does not generally guarantee that the data have yet reached the physical destination. Other "os"-specific API must be performed to assure the data integrity at the receiving device: such as checking for errors after doing a "close()" (if "os" is an ofstream, for example). For instance, uploading into the Toolkit FTP stream must be finalized with a read for the byte count delivered; otherwise, it may not work correctly.

See also

CConn_IOStream, NcbiStreamCopyStart, NcbiStreamCopyThrow

Definition at line 211 of file ncbistre.cpp.

References _ASSERT, CT_EOF, CT_EQ_INT_TYPE, and true.

Referenced by CChunkFile::Append(), CSeqIdChunkFile::Append(), CGridRPCBaseClient< CAsnBinCompressed >::AskStream(), CTmpStreamGuard::Close(), CBiosampleChkApp::CreateBiosampleUpdateWebService(), CCompareWithBiosample::CreateBiosampleUpdateWebService(), CGBenchFeedbackAttachment::EncodeData(), SAsyncWriteTask::Execute(), SFileTrackRequest::GetFileInfo(), CDoiLookup::GetPubFromCrossRef(), CCgiApplication::GetResultFromCache(), CProjectStorage::GetString(), CProjectStorage::GetVector(), CIdMapperConfig::Initialize(), CGBDocument::LoadFile(), CNetScheduleJobSerializer::LoadJobInput(), NcbiStreamCopyThrow(), CManipulatorOProxy< TInputStream, TOutputStream >::operator<<(), CManipulatorIProxy< TInputStream, TOutputStream >::operator>>(), CGridCommandLineInterfaceApp::PrepareRemoteAppJobInput(), CHttpSessionApp::PrintResponse(), CCgiRequestProcessor::ProcessHelpRequest(), CCgi2RCgiApp::ReadJob(), CSftpSampleApp::Run(), CHttpSessionApp::Run(), s_UpdateLocalFile(), CNetScheduleJobSerializer::SaveJobInput(), CNetScheduleJobSerializer::SaveJobOutput(), CCgiApplication::SaveResultToCache(), CProjectStorage::SaveStream(), CRemoteAppClientSampleApp::ShowBlob(), CRPCClient_Base::x_Ask(), CCompressedFile::x_DownloadFile(), CEutilsClient::x_FetchOnce(), CEutilsClient::x_GetOnce(), CTMS_DisplayTrack_Client::x_HttpFetch(), x_IsUrlAccessible(), CEutilsClient::x_LinkOnce(), CEutilsClient::x_LinkOnceT(), CGridCommandLineInterfaceApp::x_LoadJobInput(), CCgiRequest::x_ProcessInputStream(), and CEutilsClient::x_SearchOnce().

Similar to NcbiStreamCopyThrow() but copies (and consumes) only the specified number of bytes (and bypasses operator<< altogether).

In the event of write failure, the number of bytes consumed may fall anywhere between the number of bytes written and the target count, inclusive. If the input stream has less data than requested, copies what it can, sets that stream's eof and fail flags, and returns normally; if anything else goes wrong, throws an exception in addition to setting appropriate flags (and copying what it can).

See also

NcbiStreamCopy, NcbiStreamCopyThrow, CCoreException

Convert stream position to 64-bit int.

On most systems stream position is a structure, this function converts it to plain numeric value.

See also

NcbiInt8ToStreampos

Definition at line 771 of file ncbistre.hpp.

References CT_OFF_TYPE, and CT_POS_TYPE.

Referenced by CRowReader< TTraits >::CRowReader(), CBDB_ExtBlobStore< TBV >::Flush(), GetOssSize(), CObjectIStream::GetPosition(), CObjectOStream::GetPosition(), CObjectIStream::Location(), CLDS2_ObjectParser::ParseNext(), CProcessor_St_SE_SNPT::ProcessStream(), s_FindAttribute(), CLDS2_SeqEntry_Hook::SkipObject(), CFastaReader::StreamPosition(), CRowReader< TTraits >::Validate(), CRowReader< TTraits >::x_GetRowData(), CCgiApplication::x_OnEvent(), CLDS2_Manager::x_ParseFile(), CFastCgiApplicationMT::x_ProcessThreadedRequest(), and CRowReader< TTraits >::x_ReadNextRow().

Input the entire contents of an istream into a string (NULL causes drain).

"is" gets its failbit set if nothing was extracted from it; and gets its eofbit (w/o failbit) set if the stream has reached an EOF condition.

Parameters

pos Where in "*s" to begin saving data (ignored when "s" == NULL).

Returns

Size of copied data if the operation was successful (i.e. "is" had reached EOF), 0 otherwise.

Note

If "s" != NULL, then "s->size() >= pos" always upon return.

See also

NcbiStreamCopy

Definition at line 296 of file ncbistre.cpp.

References _ASSERT, buf, count, NcbiEofbit, NcbiFailbit, and str().

Referenced by edirect::Execute(), LoadFile(), CEUtils_Request::Read(), CId1FetchApp::Run(), fix_pub::s_IsIndexed(), and CMsvcConfigure::WriteBuildVer().

Via parameter "count" (which is guaranteed to be supplied non-NULL) return the number of bytes that are ready to be read from the input device without blocking.

Return eRW_Success if the number of pending bytes has been stored at the location pointed to by "count". Return eRW_NotImplemented if the number cannot be determined. Otherwise, return other eRW_... condition to reflect the problem ("*count" does not need to be updated in the case of non-eRW_Success). Note that if reporting 0 bytes ready, the method may return either both eRW_Success and zero "*count", or return eRW_NotImplemented alone.

Implements IReader.

Definition at line 627 of file stream_utils.cpp.

References count, eRW_Eof, eRW_Error, eRW_Success, CStreamReader::m_Stream, and NcbiEofbit.

Via parameter "count" (which is guaranteed to be supplied non-NULL) return the number of bytes that are ready to be read from the input device without blocking.

Return eRW_Success if the number of pending bytes has been stored at the location pointed to by "count". Return eRW_NotImplemented if the number cannot be determined. Otherwise, return other eRW_... condition to reflect the problem ("*count" does not need to be updated in the case of non-eRW_Success). Note that if reporting 0 bytes ready, the method may return either both eRW_Success and zero "*count", or return eRW_NotImplemented alone.

Implements IReader.

Definition at line 732 of file stream_utils.cpp.

References _ASSERT, count, eRW_Eof, eRW_Success, CStringReader::m_Position, and CStringReader::m_String.

Via parameter "count" (which is guaranteed to be supplied non-NULL) return the number of bytes that are ready to be read from the input device without blocking.

Return eRW_Success if the number of pending bytes has been stored at the location pointed to by "count". Return eRW_NotImplemented if the number cannot be determined. Otherwise, return other eRW_... condition to reflect the problem ("*count" does not need to be updated in the case of non-eRW_Success). Note that if reporting 0 bytes ready, the method may return either both eRW_Success and zero "*count", or return eRW_NotImplemented alone.

Implemented in NDirectNetStorageImpl::CROFileTrack, NDirectNetStorageImpl::CRONetCache, NDirectNetStorageImpl::CRWNotFound, NDirectNetStorageImpl::CObj, SNetStorageObjectRPC, SNetStorageObjectRPC::SIState, SNetStorage_NetCacheBlob, SNetStorage_NetCacheBlob::SIState, SH2S_ReaderWriter, CDataChunkReader, SNetStorageObjectOState, CTarReader, CMemoryReader, SPSG_BlobReader, CReaderOfLines, CxBlobReader, CBDB_CacheIReader, CNetCacheReader, CTransmissionReader, CNlmZipReader, CBlobReader, CBDB_BlobReaderWriter, CStringReader, CStreamReader, CFileReaderWriter, CFileReader, CStringOrBlobStorageReader, CSocketReaderWriter, CCgiEntryReader, SEmbeddedStreamReaderWriter, CCGIStreamReader, and CDB_Result_Reader.

Referenced by NCBI_PARAM_DEF_EX(), SEmbeddedStreamReaderWriter::PendingCount(), CTransmissionReader::PendingCount(), and CRWStreambuf::showmanyc().

Convert one single character to a "printable" form.

A "printable" form is one of well-known C-style backslash-quoted sequences ('\0', '', '', '\f', '
', '\r', '\t', '\v', '\', '\'', '"'), or '\xXX' for other non-printable characters (per isprint()), or a graphical representation of 'c' as an ASCII character.

Note

*DO NOT USE* to convert strings! Because of the '\xXX' notation, such conversions can result in ambiguity (e.g. "\xAAA" is a valid _single_-character string per the standard).

Definition at line 505 of file ncbistre.cpp.

References isprint().

Referenced by CCgiResponse::BeginPart(), and IRegistry::Write().

This method gets called by RStream buffer destructor to return buffered yet still unread (from the stream) portion of data back to the device.

It's semantically equivalent to CStreamUtils::Pushback() with the only difference that IReader can only assume the ownership of "buf" when "del_ptr" is passed non-NULL. Return eRW_Success when data have been successfully pushed back and the ownership of the pointers has been assumed as described above. Any other error code results in pointers remained and handled within the stream buffer being deleted, with an error message suppressed for eRW_NotImplemented (default implementation).

See also

CStreamUtils::Pushback

Reimplemented in CStreamReader, and CSocketReaderWriter.

Definition at line 579 of file stream_utils.cpp.

References eRW_NotImplemented.

Referenced by CRWStreambuf::x_Pushback().

Read as many as "count" bytes into a buffer pointed to by the "buf" argument.

Always store the number of bytes actually read (0 if read none) via the pointer "bytes_read", if provided non-NULL. Return non-eRW_Success code if EOF / error condition has been encountered during the operation (some data may have been read, nevertheless, and reflected in "*bytes_read"). Special case: if "count" is passed as 0, then the value of "buf" must be ignored, and no change should be made to the state of the input device (but may return non-eRW_Success to indicate that the input device has already been in an error condition).

Note

Apparently, may not return eRW_Success if hasn't been able to read "count" bytes as requested, and "bytes_read" was provided as NULL.

When returning "*bytes_read" as zero for a non-zero "count" requested, the return status should not indicate eRW_Success.

Warning

"*bytes_read" may never be returned greater than "count".

Attention

It is implementation-dependent whether the call blocks until the entire buffer is read or the call returns when at least some data are available. In general, it is advised that this call is made within a loop that checks for EOF condition and proceeds with the reading until the required amount of data has been retrieved.

Implements IReader.

Definition at line 600 of file stream_utils.cpp.

References buf, count, eRW_Eof, eRW_Error, eRW_Success, CStreamReader::m_Stream, NcbiBadbit, NcbiEofbit, NcbiFailbit, ok, r(), and result.

Read as many as "count" bytes into a buffer pointed to by the "buf" argument.

Always store the number of bytes actually read (0 if read none) via the pointer "bytes_read", if provided non-NULL. Return non-eRW_Success code if EOF / error condition has been encountered during the operation (some data may have been read, nevertheless, and reflected in "*bytes_read"). Special case: if "count" is passed as 0, then the value of "buf" must be ignored, and no change should be made to the state of the input device (but may return non-eRW_Success to indicate that the input device has already been in an error condition).

Note

Apparently, may not return eRW_Success if hasn't been able to read "count" bytes as requested, and "bytes_read" was provided as NULL.

When returning "*bytes_read" as zero for a non-zero "count" requested, the return status should not indicate eRW_Success.

Warning

"*bytes_read" may never be returned greater than "count".

Attention

It is implementation-dependent whether the call blocks until the entire buffer is read or the call returns when at least some data are available. In general, it is advised that this call is made within a loop that checks for EOF condition and proceeds with the reading until the required amount of data has been retrieved.

Implements IReader.

Definition at line 711 of file stream_utils.cpp.

References _ASSERT, buf, count, eRW_Eof, eRW_Error, eRW_Success, CStringReader::m_Position, CStringReader::m_String, min(), and n.

Read as many as "count" bytes into a buffer pointed to by the "buf" argument.

Always store the number of bytes actually read (0 if read none) via the pointer "bytes_read", if provided non-NULL. Return non-eRW_Success code if EOF / error condition has been encountered during the operation (some data may have been read, nevertheless, and reflected in "*bytes_read"). Special case: if "count" is passed as 0, then the value of "buf" must be ignored, and no change should be made to the state of the input device (but may return non-eRW_Success to indicate that the input device has already been in an error condition).

Note

Apparently, may not return eRW_Success if hasn't been able to read "count" bytes as requested, and "bytes_read" was provided as NULL.

When returning "*bytes_read" as zero for a non-zero "count" requested, the return status should not indicate eRW_Success.

Warning

"*bytes_read" may never be returned greater than "count".

Attention

It is implementation-dependent whether the call blocks until the entire buffer is read or the call returns when at least some data are available. In general, it is advised that this call is made within a loop that checks for EOF condition and proceeds with the reading until the required amount of data has been retrieved.

Implemented in NDirectNetStorageImpl::CROFileTrack, NDirectNetStorageImpl::CRONetCache, NDirectNetStorageImpl::CRWNotFound, SNetStorageObjectRPC::SIState, SNetStorage_NetCacheBlob::SIState, SNetStorageObjectOState, CNetCacheReader, SH2S_ReaderWriter, CDataChunkReader, CTarReader, SPSG_BlobReader, CReaderOfLines, CxBlobReader, CCGIStreamReader, CTransmissionReader, CNlmZipReader, CBlobReader, CFileReaderWriter, CFileReader, CStringOrBlobStorageReader, CSocketReaderWriter, SNetStorageObjectRPC, SNetStorage_NetCacheBlob, CMemoryReader, CBDB_CacheIReader, CDB_Result_Reader, CBDB_BlobReaderWriter, CStringReader, CStreamReader, CCgiEntryReader, SEmbeddedStreamReaderWriter, and NDirectNetStorageImpl::CObj.

Referenced by CSegmentSmearGlyph::CSegMap::Deserialize(), g_ExtractReaderContents(), NCBI_PARAM_DEF_EX(), CIRByteSourceReader::Read(), SEmbeddedStreamReaderWriter::Read(), CNlmZipReader::Read(), CTransmissionReader::Read(), SNetCacheAPIImpl::ReadBuffer(), CTransmissionReader::ReadData(), CNcbiSample_Dbapi_Advanced_Features::RunSample(), CRWStreambuf::underflow(), CNlmZipReader::x_Read(), CRWStreambuf::x_Read(), CBufferedLineReader::x_ReadBuffer(), CWigBufferedLineReader::x_ReadBuffer(), and CNlmZipReader::x_ReadZipHeader().

Read all input data from stream and try convert it into UTF8 string.

Parameters

input Input text stream result UTF8 string (but it can be a raw octet string if the encoding is unknown) what_if_no_bom What to do if the 'encoding_form' is passed "eEncodingForm_Unknown" and the BOM is not detected in the stream

Returns

The encoding as detected based on the BOM ("eEncodingForm_Unknown" if there was no BOM).

Definition at line 650 of file ncbistre.cpp.

References CUtf8::AsUTF8(), buf, eEncoding_Ascii, eEncoding_ISO8859_1, eEncoding_Unknown, eEncoding_UTF8, eEncoding_Windows_1252, eEncodingForm_ISO8859_1, eEncodingForm_Unknown, eEncodingForm_Utf16Foreign, eEncodingForm_Utf16Native, eEncodingForm_Utf8, eEncodingForm_Windows_1252, eNoBOM_GuessEncoding, CUtf8::GetValidBytesCount(), CUtf8::GuessEncoding(), input(), int, max(), n, NCBI_THROW, NcbiSys_swab, result, and tmp.

Referenced by CCgiEntry::GetValueAsUTF8(), and IRWRegistry::Read().

Write up to "count" bytes from the buffer pointed to by the "buf" argument onto the output device.

Always store the number of bytes actually written, or 0 if "count" has been passed as 0 ("buf" must be ignored in this case), via the "bytes_written" pointer, if provided non-NULL. Note that the method can return non-eRW_Success in case of an I/O error along with indicating (some) data delivered to the output device (and reflected in "*bytes_written").

Note

Apparently, may not return eRW_Success if hasn't been able to write "count" bytes as requested, and "bytes_written" was passed as NULL.

When returning "*bytes_written" as zero for a non-zero "count" requested, the return status should not indicate eRW_Success.

Warning

"*bytes_written" may never be returned greater than "count".

Attention

It is implementation-dependent whether the call blocks until the entire buffer or only some data has been written out. In general, it is advised that this call is made within a loop that checks for errors and proceeds with the writing until the required amount of data has been sent.

Implements IWriter.

Definition at line 659 of file stream_utils.cpp.

References buf, count, eRW_Error, eRW_Success, CStreamWriter::m_Stream, NcbiBadbit, NcbiFailbit, ok, and result.

Write up to "count" bytes from the buffer pointed to by the "buf" argument onto the output device.

Always store the number of bytes actually written, or 0 if "count" has been passed as 0 ("buf" must be ignored in this case), via the "bytes_written" pointer, if provided non-NULL. Note that the method can return non-eRW_Success in case of an I/O error along with indicating (some) data delivered to the output device (and reflected in "*bytes_written").

Note

Apparently, may not return eRW_Success if hasn't been able to write "count" bytes as requested, and "bytes_written" was passed as NULL.

When returning "*bytes_written" as zero for a non-zero "count" requested, the return status should not indicate eRW_Success.

Warning

"*bytes_written" may never be returned greater than "count".

Attention

It is implementation-dependent whether the call blocks until the entire buffer or only some data has been written out. In general, it is advised that this call is made within a loop that checks for errors and proceeds with the writing until the required amount of data has been sent.

Implemented in CBufferWriter< TBuffer >, CBufferWriter< Buffer >, CBufferWriter< TBuffer >, CBufferWriter< Buffer >, COSSWriter, COSSWriter, COSSWriter, COctetStringSequenceWriter, NDirectNetStorageImpl::CWOFileTrack, NDirectNetStorageImpl::CWONetCache, NDirectNetStorageImpl::CRWNotFound, SNetStorageObjectRPC::SOState, SNetStorage_NetCacheBlob::SOState, SIoStreamEmbeddedStreamReaderWriter, SNetStorageObjectIState, SH2S_ReaderWriter, CStringOrWriter, CMD5StreamWriter< Buffer >, CxBlobWriter, CBDB_CacheIWriter, CNetCacheWriter, CCgiStreamWrapperWriter, CTransmissionWriter, CMultiWriter, CChecksumStreamWriter, CWriter_HTMLEncoder, CBlobWriter, CFileReaderWriter, CFileWriter, CSocketReaderWriter, SNetStorageObjectRPC, SNetStorage_NetCacheBlob, CNullWriter, CBDB_BlobReaderWriter, CStreamWriter, SEmbeddedStreamReaderWriter, and NDirectNetStorageImpl::CObj.

Referenced by CWriterSourceCollector::AddChunk(), CRWStreambuf::overflow(), CNcbiSample_Dbapi_Advanced_Features::RunSample(), CSegmentSmearGlyph::CSegMap::Serialize(), SEmbeddedStreamReaderWriter::Write(), CTransmissionWriter::Write(), CTransmissionWriter::WriteUint4(), and CRWStreambuf::xsputn().

Definition at line 379 of file stream_utils.cpp.

References _ASSERT, buf, CT_CHAR_TYPE, CStreamUtils::ePushback_Copy, CStreamUtils::ePushback_NoCopy, CStreamUtils::ePushback_Stepback, CPushback_Streambuf::kMinBufSize, CPushback_Streambuf::m_Buf, CPushback_Streambuf::m_BufSize, CPushback_Streambuf::m_DelPtr, max(), memmove, and NCBI_THROW.

Referenced by CStreamUtils::Pushback(), and CStreamUtils::Stepback().

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4