summaryrefslogtreecommitdiff
path: root/include/fud_drain.hpp
blob: 13c878a39f1e4c9e9471bf84f45f9a1c92f0d212 (plain)
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
/*
 * libfud
 * Copyright 2024 Dominick Allen
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef FUD_DRAIN_HPP
#define FUD_DRAIN_HPP

#include "fud_status.hpp"

#include <concepts>
#include <cstddef>

namespace fud {

struct DrainResult {
    size_t bytesDrained;
    FudStatus status;
    [[nodiscard]] constexpr bool isOkay()
    {
        return status == FudStatus::Success;
    }

    constexpr bool operator==(const DrainResult&) const noexcept = default;
};

template <typename Sink, typename Source>
concept Drainable = requires (Sink sink, Source source)
{
    { sink.drain(source) } -> std::same_as<DrainResult>;
};

} // namespace fud

#endif