/usr/include/seqan/stream/write.h is in seqan-dev 1.4.2+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 | // ==========================================================================
// SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2013, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of Knut Reinert or the FU Berlin nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Hannes Hauswedell <hauswedell@mi.fu-berlin.de>
// ==========================================================================
// Main File for record- and Document-writing. Contains only doc right now.
// ==========================================================================
#ifndef SEQAN_STREAM_WRITE_H_
#define SEQAN_STREAM_WRITE_H_
namespace seqan {
// ============================================================================
// Forwards
// ============================================================================
// ============================================================================
// Tags, Classes, Enums
// ============================================================================
// ============================================================================
// Metafunctions
// ============================================================================
// ============================================================================
// Functions
// ============================================================================
// TODO(holtgrew): These functions do not really belong to the Stream concept.
/*!
* @fn StreamConcept#writeRecord
* @headerfile <seqan/stream.h>
* @brief Write one record (e.g. a single DNA-sequence and its meta data) to a @link StreamConcept @endlink
*
* @signature int writeRecord(stream, RECORD, tag);
*
* @param[in] RECORD possibly multiple fields (e.g. meta and sequence)
* @param[in] tag The file format tag
* @param[in,out] stream The Stream object to write to. Type: StreamConcept
*
* @return int An integer with the status code (0 on success).
*
* @see StreamConcept#write2
*/
/**
.Function.writeRecord
..cat:Input/Output
..summary:write one record (e.g. a single DNA-sequence and its meta data) to a @Concept.StreamConcept@
..signature:writeRecord(TStream & stream, <format specific>, TTag const &)
..param.stream:The Stream object to write to
...type:Concept.StreamConcept
..param.format specific: possibly multiple fields (e.g. meta and sequence)
..param.TTag:The file format tag
..see:Function.write2
..include:seqan/stream.h
*/
/*!
* @fn StreamConcept#write2
* @headerfile <seqan/stream.h>
* @brief Writes an entire document to a @link StreamConcept @endlink.
*
* @signature write2(stream, DOCUMENT, tag);
*
* @param[in,out] stream The Stream object to write to. Types: StreamConcept
* @param[in] DOCUMENT Format specific possibly multiple StringSets (e.g. of meta and sequences).
* @param[in] tag The file format tag
*
* @section Status
*
* Should be renamed to "write" once the old IO-Code is removed
*
* @see StreamConcept#writeRecord
*/
/**
.Function.write2
..cat:Input/Output
..summary:writes an entire document to a @Concept.StreamConcept@
..signature:write2(TStream & stream, <format specific>, TTag const &)
..param.stream:The Stream object to write to
...type:Concept.StreamConcept
..param.format specific: possibly multiple StringSets (e.g. of meta and sequences)
..param.TTag:The file format tag
..status:Should be renamed to "write" once the old IO-Code is removed
..include:seqan/stream.h
..see:Function.writeRecord
*/
} // namespace seqan
#endif // #ifndef SEQAN_STREAM_WRITE_H_
|