seqan3/main_user/sam__file_2output__options_8hpp_source.html

// SPDX-FileCopyrightText: 2006-2025 Knut Reinert & Freie Universität Berlin

// SPDX-FileCopyrightText: 2016-2025 Knut Reinert & MPI für molekulare Genetik

// SPDX-License-Identifier: BSD-3-Clause


#pragma once


#include <seqan3/core/platform.hpp>


namespace seqan3

{


struct sam_file_output_options

{

    bool add_carriage_return = false;


    bool sam_require_header = true;

};


} // namespace seqan3

seqan3
The main SeqAn3 namespace.
Definition aligned_sequence_concept.hpp:26

platform.hpp
Provides platform and dependency checks.

seqan3::sam_file_output_options
The options type defines various option members that influence the behavior of all or some formats.
Definition sam_file/output_options.hpp:23

seqan3::sam_file_output_options::add_carriage_return
bool add_carriage_return
The default plain text line-ending is "\n", but on Windows an additional carriage return is recommend...
Definition sam_file/output_options.hpp:27

seqan3::sam_file_output_options::sam_require_header
bool sam_require_header
Whether to require a header for SAM files.
Definition sam_file/output_options.hpp:41