StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
attachment.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Multimedia.
5 *
6 * StormByte-Multimedia original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Multimedia source in this
20 * file. Third-party components — including FFmpeg and embedded trained data —
21 * remain under their own licenses and are not covered by the commercial grant.
22 *
23 * A written StormByte commercial agreement may license this original source
24 * on terms other than the LGPL, including specific use, distribution or
25 * linking arrangements such as static linking, as stated in that agreement.
26 * It does not grant rights to dependencies or waive their license conditions.
27 * Enabling WITH_GPL or WITH_NONFREE may include components with separate
28 * obligations for modification, linking (static or dynamic), redistribution
29 * or works that incorporate them. The person modifying, linking, packaging or
30 * distributing the resulting work is responsible for determining and meeting
31 * all applicable requirements, including any needed patent permissions.
32 * A StormByte commercial agreement does not provide those rights for GPL or
33 * nonfree components.
34 *
35 * Neither license grants any patent rights. Any patent licenses required
36 * to use this software or third-party components must be obtained separately
37 * from the patent holders.
38 *
39 * StormByte-Multimedia is distributed in the hope that it will be useful,
40 * but WITHOUT ANY WARRANTY; without even the implied warranty of
41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
42 * GNU Lesser General Public License for more details.
43 *
44 * You should have received a copy of the GNU Lesser General Public License
45 * version 3 along with StormByte-Multimedia. If not, see
46 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
47 *
48 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
49 */
50
51#pragma once
52
53#include <StormByte/buffer/fifo.hxx>
55
56#include <StormByte/safe/optional.hxx>
57#include <StormByte/safe/string.hxx>
58#include <StormByte/safe/vector.hxx>
59
64namespace StormByte {
69 namespace Multimedia {
80 public:
86
95 StormByte::Buffer::FIFO payload) noexcept;
96
102 Attachment(const Attachment& other);
103
108 Attachment(Attachment&& other) noexcept;
109
113 ~Attachment() noexcept;
114
121 Attachment& operator=(const Attachment& other);
122
128 Attachment& operator=(Attachment&& other) noexcept;
129
134 const StormByte::Safe::Optional<StormByte::Safe::String>& FileName() const noexcept;
135
140 const StormByte::Safe::Optional<StormByte::Safe::String>& MimeType() const noexcept;
141
146 const StormByte::Buffer::FIFO& Payload() const noexcept;
147
148 private:
149 StormByte::Safe::Optional<StormByte::Safe::String> m_fileName;
150 StormByte::Safe::Optional<StormByte::Safe::String> m_mimeType;
151 StormByte::Buffer::FIFO m_payload;
152 };
153 }
154}
155
161
166namespace StormByte {
171 namespace Multimedia {
176 }
177}
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Attachment(Attachment &&other) noexcept
Move constructor.
const StormByte::Buffer::FIFO & Payload() const noexcept
Attachment bytes.
Attachment(StormByte::Safe::Optional< StormByte::Safe::String > fileName, StormByte::Safe::Optional< StormByte::Safe::String > mimeType, StormByte::Buffer::FIFO payload) noexcept
Builds an attachment.
Attachment(const Attachment &other)
Copies attachment metadata and payload state.
Attachment()
Constructs an empty attachment.
~Attachment() noexcept
Destructor.
const StormByte::Safe::Optional< StormByte::Safe::String > & MimeType() const noexcept
MIME type.
const StormByte::Safe::Optional< StormByte::Safe::String > & FileName() const noexcept
Original file name.
Multimedia module of the StormByte suite.
Typed item queues provided by StormByte-Buffer.
StormByte::Safe::Vector< Attachment > Attachments
Ordered attachments with creator-owned Safe storage.
Definition attachment.hxx:175
Root namespace of the StormByte C++ suite.
#define STORMBYTE_MULTIMEDIA_PUBLIC
Definition visibility.h:61