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
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

// Copyright 2020 John Millikin and the rust-fuse contributors.
//
// 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.
//
// SPDX-License-Identifier: Apache-2.0

use crate::protocol::prelude::*;

#[cfg(test)]
mod opendir_test;

// OpendirRequest {{{

/// Request type for [`FuseHandlers::opendir`].
///
/// [`FuseHandlers::opendir`]: ../../trait.FuseHandlers.html#method.opendir
pub struct OpendirRequest<'a> {
	phantom: PhantomData<&'a ()>,
	node_id: NodeId,
	flags: u32,
}

impl OpendirRequest<'_> {
	pub fn node_id(&self) -> NodeId {
		self.node_id
	}

	/// Platform-specific flags passed to [`open(2)`].
	///
	/// [`open(2)`]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/open.html
	pub fn flags(&self) -> u32 {
		self.flags
	}
}

impl fmt::Debug for OpendirRequest<'_> {
	fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
		fmt.debug_struct("OpendirRequest")
			.field("node_id", &self.node_id)
			.field("flags", &DebugHexU32(self.flags))
			.finish()
	}
}

impl<'a> fuse_io::DecodeRequest<'a> for OpendirRequest<'a> {
	fn decode_request(
		mut dec: fuse_io::RequestDecoder<'a>,
	) -> Result<Self, Error> {
		let header = dec.header();
		debug_assert!(header.opcode == fuse_kernel::FUSE_OPENDIR);

		let raw: &'a fuse_kernel::fuse_open_in = dec.next_sized()?;
		Ok(Self {
			phantom: PhantomData,
			node_id: try_node_id(header.nodeid)?,
			flags: raw.flags,
		})
	}
}

// }}}

// OpendirResponse {{{

/// Response type for [`FuseHandlers::opendir`].
///
/// [`FuseHandlers::opendir`]: ../../trait.FuseHandlers.html#method.opendir
pub struct OpendirResponse<'a> {
	phantom: PhantomData<&'a ()>,
	handle: u64,
	flags: OpendirResponseFlags,
}

impl<'a> OpendirResponse<'a> {
	pub fn new() -> OpendirResponse<'a> {
		Self {
			phantom: PhantomData,
			handle: 0,
			flags: OpendirResponseFlags::new(),
		}
	}

	pub fn handle(&self) -> u64 {
		self.handle
	}

	pub fn set_handle(&mut self, handle: u64) {
		self.handle = handle;
	}

	pub fn flags(&self) -> &OpendirResponseFlags {
		&self.flags
	}

	pub fn flags_mut(&mut self) -> &mut OpendirResponseFlags {
		&mut self.flags
	}
}

impl fmt::Debug for OpendirResponse<'_> {
	fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
		fmt.debug_struct("OpendirResponse")
			.field("handle", &self.handle)
			.field("flags", &self.flags())
			.finish()
	}
}
impl fuse_io::EncodeResponse for OpendirResponse<'_> {
	fn encode_response<'a, Chan: fuse_io::Channel>(
		&'a self,
		enc: fuse_io::ResponseEncoder<Chan>,
	) -> Result<(), Chan::Error> {
		enc.encode_sized(&fuse_kernel::fuse_open_out {
			fh: self.handle,
			open_flags: self.flags.to_bits(),
			padding: 0,
		})
	}
}

// }}}

// OpendirResponseFlags {{{

bitflags_struct! {
	/// Optional flags set on [`OpendirResponse`].
	///
	/// [`OpendirResponse`]: struct.OpendirResponse.html
	pub struct OpendirResponseFlags(u32);

	/// Allow the kernel to preserve cached directory entries from the last
	/// time this directory was opened.
	fuse_kernel::FOPEN_KEEP_CACHE: keep_cache,

	/// Tell the kernel this directory is not seekable.
	fuse_kernel::FOPEN_NONSEEKABLE: nonseekable,

	// TODO: CACHE_DIR
}

// }}}