blob: 2ec85f6f0feb80e9bf27f5c454f6df697b95ee9d [file]
// SPDX-License-Identifier: MPL-2.0 OR LGPL-3.0-or-later
/*
* libpathrs: safe path resolution on Linux
* Copyright (C) 2019-2025 SUSE LLC
* Copyright (C) 2026 Aleksa Sarai <cyphar@cyphar.com>
*
* == MPL-2.0 ==
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
*
* Alternatively, this Source Code Form may also (at your option) be used
* under the terms of the GNU Lesser General Public License Version 3, as
* described below:
*
* == LGPL-3.0-or-later ==
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
* Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
use crate::{error::Error, flags::OpenFlags, tests::traits::ErrorImpl, Handle, HandleRef};
use std::{
fs::File,
os::unix::io::{AsFd, OwnedFd},
};
pub(in crate::tests) trait HandleImpl: AsFd + std::fmt::Debug + Sized {
type Cloned: HandleImpl<Error = Self::Error> + Into<OwnedFd>;
type Error: ErrorImpl;
// Only used by the capi tests.
#[cfg_attr(not(feature = "capi"), allow(dead_code))]
// NOTE: We return Self::Cloned so that we can share types with HandleRef.
fn from_fd(fd: impl Into<OwnedFd>) -> Self::Cloned;
fn try_clone(&self) -> Result<Self::Cloned, anyhow::Error>;
fn reopen(&self, flags: impl Into<OpenFlags>) -> Result<File, Self::Error>;
}
impl HandleImpl for Handle {
type Cloned = Handle;
type Error = Error;
fn from_fd(fd: impl Into<OwnedFd>) -> Self::Cloned {
Self::Cloned::from_fd(fd)
}
fn try_clone(&self) -> Result<Self::Cloned, anyhow::Error> {
self.as_ref().try_clone().map_err(From::from)
}
fn reopen(&self, flags: impl Into<OpenFlags>) -> Result<File, Self::Error> {
self.as_ref().reopen(flags)
}
}
impl HandleImpl for &Handle {
type Cloned = Handle;
type Error = Error;
fn from_fd(fd: impl Into<OwnedFd>) -> Self::Cloned {
Self::Cloned::from_fd(fd)
}
fn try_clone(&self) -> Result<Self::Cloned, anyhow::Error> {
Handle::try_clone(self).map_err(From::from)
}
fn reopen(&self, flags: impl Into<OpenFlags>) -> Result<File, Self::Error> {
Handle::reopen(self, flags)
}
}
impl HandleImpl for HandleRef<'_> {
type Cloned = Handle;
type Error = Error;
fn from_fd(fd: impl Into<OwnedFd>) -> Self::Cloned {
Self::Cloned::from_fd(fd)
}
fn try_clone(&self) -> Result<Self::Cloned, anyhow::Error> {
self.try_clone().map_err(From::from)
}
fn reopen(&self, flags: impl Into<OpenFlags>) -> Result<File, Self::Error> {
self.reopen(flags)
}
}
impl HandleImpl for &HandleRef<'_> {
type Cloned = Handle;
type Error = Error;
fn from_fd(fd: impl Into<OwnedFd>) -> Self::Cloned {
Self::Cloned::from_fd(fd)
}
fn try_clone(&self) -> Result<Self::Cloned, anyhow::Error> {
HandleRef::try_clone(self).map_err(From::from)
}
fn reopen(&self, flags: impl Into<OpenFlags>) -> Result<File, Self::Error> {
HandleRef::reopen(self, flags)
}
}