mirror of
https://github.com/matrix-construct/construct
synced 2024-10-30 10:28:55 +01:00
41 lines
1.2 KiB
C++
41 lines
1.2 KiB
C++
// Matrix Construct
|
|
//
|
|
// Copyright (C) Matrix Construct Developers, Authors & Contributors
|
|
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
|
|
//
|
|
// Permission to use, copy, modify, and/or distribute this software for any
|
|
// purpose with or without fee is hereby granted, provided that the above
|
|
// copyright notice and this permission notice is present in all copies. The
|
|
// full license for this software is available in the LICENSE file.
|
|
|
|
#pragma once
|
|
#define HAVE_IRCD_FS_READ_H
|
|
|
|
namespace ircd::fs
|
|
{
|
|
struct read_opts extern const read_opts_default;
|
|
|
|
// Yields ircd::ctx for read into buffer; returns view of read portion.
|
|
string_view read(const string_view &path, const mutable_buffer &, const read_opts & = read_opts_default);
|
|
|
|
// Yields ircd::ctx for read into allocated string; returns that string
|
|
std::string read(const string_view &path, const read_opts & = read_opts_default);
|
|
}
|
|
|
|
/// Options for a read operation
|
|
struct ircd::fs::read_opts
|
|
{
|
|
read_opts() = default;
|
|
read_opts(const off_t &);
|
|
|
|
/// Offset in the file to start the read from.
|
|
off_t offset {0};
|
|
|
|
/// Request priority (this option may be improved, avoid for now)
|
|
int16_t priority {0};
|
|
};
|
|
|
|
inline
|
|
ircd::fs::read_opts::read_opts(const off_t &offset)
|
|
:offset{offset}
|
|
{}
|