mirror of https://github.com/chipsenkbeil/distant
More progress
Chip Senkbeil
7 months ago
parent
d6c3b0a155
commit
c88f96baba
@ -0,0 +1,29 @@
|
||||
/// Full API that represents a distant-compatible server.
|
||||
pub trait Api {
|
||||
type FileSystem: FileSystemApi;
|
||||
type Process: ProcessApi;
|
||||
type Search: SearchApi;
|
||||
type SystemInfo: SystemInfoApi;
|
||||
type Version: VersionApi;
|
||||
}
|
||||
|
||||
/// API supporting filesystem operations.
|
||||
pub trait FileSystemApi {}
|
||||
|
||||
/// API supporting process creation and manipulation.
|
||||
pub trait ProcessApi {}
|
||||
|
||||
/// API supporting searching through the remote system.
|
||||
pub trait SearchApi {}
|
||||
|
||||
/// API supporting retrieval of information about the remote system.
|
||||
pub trait SystemInfoApi {}
|
||||
|
||||
/// API supporting retrieval of the server's version.
|
||||
pub trait VersionApi {}
|
||||
|
||||
/// Generic struct that implements all APIs as unsupported.
|
||||
pub struct Unsupported;
|
||||
|
||||
impl FileSystemApi for Unsupported {
|
||||
}
|
||||
@ -0,0 +1,6 @@
|
||||
mod destination;
|
||||
mod map;
|
||||
mod utils;
|
||||
|
||||
pub use destination::{Destination, Host, HostParseError};
|
||||
pub use map::{Map, MapParseError};
|
||||
@ -0,0 +1,46 @@
|
||||
use std::fmt;
|
||||
use std::marker::PhantomData;
|
||||
use std::str::FromStr;
|
||||
|
||||
use serde::de::{Deserializer, Error as SerdeError, Visitor};
|
||||
use serde::ser::Serializer;
|
||||
|
||||
/// From https://docs.rs/serde_with/1.14.0/src/serde_with/rust.rs.html#90-118
|
||||
pub fn deserialize_from_str<'de, D, T>(deserializer: D) -> Result<T, D::Error>
|
||||
where
|
||||
D: Deserializer<'de>,
|
||||
T: FromStr,
|
||||
T::Err: fmt::Display,
|
||||
{
|
||||
struct Helper<S>(PhantomData<S>);
|
||||
|
||||
impl<'de, S> Visitor<'de> for Helper<S>
|
||||
where
|
||||
S: FromStr,
|
||||
<S as FromStr>::Err: fmt::Display,
|
||||
{
|
||||
type Value = S;
|
||||
|
||||
fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
write!(formatter, "a string")
|
||||
}
|
||||
|
||||
fn visit_str<E>(self, value: &str) -> Result<Self::Value, E>
|
||||
where
|
||||
E: SerdeError,
|
||||
{
|
||||
value.parse::<Self::Value>().map_err(SerdeError::custom)
|
||||
}
|
||||
}
|
||||
|
||||
deserializer.deserialize_str(Helper(PhantomData))
|
||||
}
|
||||
|
||||
/// From https://docs.rs/serde_with/1.14.0/src/serde_with/rust.rs.html#121-127
|
||||
pub fn serialize_to_str<T, S>(value: &T, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
T: fmt::Display,
|
||||
S: Serializer,
|
||||
{
|
||||
serializer.collect_str(&value)
|
||||
}
|
||||
@ -0,0 +1,312 @@
|
||||
use std::future::Future;
|
||||
use std::io;
|
||||
|
||||
use async_trait::async_trait;
|
||||
use distant_core_auth::Authenticator;
|
||||
|
||||
use crate::common::{Destination, Map};
|
||||
|
||||
/// Boxed [`LaunchHandler`].
|
||||
pub type BoxedLaunchHandler = Box<dyn LaunchHandler>;
|
||||
|
||||
/// Boxed [`ConnectHandler`].
|
||||
pub type BoxedConnectHandler = Box<dyn ConnectHandler>;
|
||||
|
||||
/// Interface for a handler to launch a server, returning the destination to the server.
|
||||
#[async_trait]
|
||||
pub trait LaunchHandler: Send + Sync {
|
||||
/// Launches a server using the target `destination`. If the destination is unsupported, this
|
||||
/// method will return an error.
|
||||
///
|
||||
/// * Takes `options` as additional parameters custom to the destination.
|
||||
/// * Takes `authenticator` to handle any authentication needs.
|
||||
async fn launch(
|
||||
&self,
|
||||
destination: &Destination,
|
||||
options: &Map,
|
||||
authenticator: &mut dyn Authenticator,
|
||||
) -> io::Result<Destination>;
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<F, R> LaunchHandler for F
|
||||
where
|
||||
F: Fn(&Destination, &Map, &mut dyn Authenticator) -> R + Send + Sync + 'static,
|
||||
R: Future<Output = io::Result<Destination>> + Send + 'static,
|
||||
{
|
||||
async fn launch(
|
||||
&self,
|
||||
destination: &Destination,
|
||||
options: &Map,
|
||||
authenticator: &mut dyn Authenticator,
|
||||
) -> io::Result<Destination> {
|
||||
self(destination, options, authenticator).await
|
||||
}
|
||||
}
|
||||
|
||||
/// Generates a new [`LaunchHandler`] for the provided anonymous function.
|
||||
///
|
||||
/// ### Examples
|
||||
///
|
||||
/// ```
|
||||
/// use distant_core_plugin::boxed_launch_handler;
|
||||
///
|
||||
/// let _handler = boxed_launch_handler!(|destination, options, authenticator| {
|
||||
/// todo!("Implement handler logic.");
|
||||
/// });
|
||||
///
|
||||
/// let _handler = boxed_launch_handler!(|destination, options, authenticator| async {
|
||||
/// todo!("We support async within as well regardless of the keyword!");
|
||||
/// });
|
||||
///
|
||||
/// let _handler = boxed_launch_handler!(move |destination, options, authenticator| {
|
||||
/// todo!("You can also explicitly mark to move into the closure");
|
||||
/// });
|
||||
/// ```
|
||||
#[macro_export]
|
||||
macro_rules! boxed_launch_handler {
|
||||
(|$destination:ident, $options:ident, $authenticator:ident| $(async)? $body:block) => {{
|
||||
let x: $crate::handlers::BoxedLaunchHandler = Box::new(
|
||||
|$destination: &$crate::common::Destination,
|
||||
$options: &$crate::common::Map,
|
||||
$authenticator: &mut dyn $crate::auth::Authenticator| async { $body },
|
||||
);
|
||||
x
|
||||
}};
|
||||
(move |$destination:ident, $options:ident, $authenticator:ident| $(async)? $body:block) => {{
|
||||
let x: $crate::handlers::BoxedLaunchHandler = Box::new(
|
||||
move |$destination: &$crate::common::Destination,
|
||||
$options: &$crate::common::Map,
|
||||
$authenticator: &mut dyn $crate::auth::Authenticator| async move { $body },
|
||||
);
|
||||
x
|
||||
}};
|
||||
}
|
||||
|
||||
/// Interface for a handler to connect to a server, returning a boxed client to the server.
|
||||
#[async_trait]
|
||||
pub trait ConnectHandler: Send + Sync {
|
||||
/// Connects to a server at the specified `destination`. If the destination is unsupported,
|
||||
/// this method will return an error.
|
||||
///
|
||||
/// * Takes `options` as additional parameters custom to the destination.
|
||||
/// * Takes `authenticator` to handle any authentication needs.
|
||||
async fn connect(
|
||||
&self,
|
||||
destination: &Destination,
|
||||
options: &Map,
|
||||
authenticator: &mut dyn Authenticator,
|
||||
) -> io::Result<UntypedClient>;
|
||||
}
|
||||
|
||||
#[async_trait]
|
||||
impl<F, R> ConnectHandler for F
|
||||
where
|
||||
F: Fn(&Destination, &Map, &mut dyn Authenticator) -> R + Send + Sync + 'static,
|
||||
R: Future<Output = io::Result<UntypedClient>> + Send + 'static,
|
||||
{
|
||||
async fn connect(
|
||||
&self,
|
||||
destination: &Destination,
|
||||
options: &Map,
|
||||
authenticator: &mut dyn Authenticator,
|
||||
) -> io::Result<UntypedClient> {
|
||||
self(destination, options, authenticator).await
|
||||
}
|
||||
}
|
||||
|
||||
/// Generates a new [`ConnectHandler`] for the provided anonymous function.
|
||||
///
|
||||
/// ### Examples
|
||||
///
|
||||
/// ```
|
||||
/// use distant_core_plugin::boxed_connect_handler;
|
||||
///
|
||||
/// let _handler = boxed_connect_handler!(|destination, options, authenticator| {
|
||||
/// todo!("Implement handler logic.");
|
||||
/// });
|
||||
///
|
||||
/// let _handler = boxed_connect_handler!(|destination, options, authenticator| async {
|
||||
/// todo!("We support async within as well regardless of the keyword!");
|
||||
/// });
|
||||
///
|
||||
/// let _handler = boxed_connect_handler!(move |destination, options, authenticator| {
|
||||
/// todo!("You can also explicitly mark to move into the closure");
|
||||
/// });
|
||||
/// ```
|
||||
#[macro_export]
|
||||
macro_rules! boxed_connect_handler {
|
||||
(|$destination:ident, $options:ident, $authenticator:ident| $(async)? $body:block) => {{
|
||||
let x: $crate::handlers::BoxedConnectHandler = Box::new(
|
||||
|$destination: &$crate::common::Destination,
|
||||
$options: &$crate::common::Map,
|
||||
$authenticator: &mut dyn $crate::auth::Authenticator| async { $body },
|
||||
);
|
||||
x
|
||||
}};
|
||||
(move |$destination:ident, $options:ident, $authenticator:ident| $(async)? $body:block) => {{
|
||||
let x: $crate::handlers::BoxedConnectHandler = Box::new(
|
||||
move |$destination: &$crate::common::Destination,
|
||||
$options: &$crate::common::Map,
|
||||
$authenticator: &mut dyn $crate::auth::Authenticator| async move { $body },
|
||||
);
|
||||
x
|
||||
}};
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use test_log::test;
|
||||
|
||||
use super::*;
|
||||
use crate::common::FramedTransport;
|
||||
|
||||
#[inline]
|
||||
fn test_destination() -> Destination {
|
||||
"scheme://host:1234".parse().unwrap()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn test_options() -> Map {
|
||||
Map::default()
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn test_authenticator() -> impl Authenticator {
|
||||
FramedTransport::pair(1).0
|
||||
}
|
||||
|
||||
#[test(tokio::test)]
|
||||
async fn boxed_launch_handler_should_generate_valid_boxed_launch_handler() {
|
||||
let handler = boxed_launch_handler!(|_destination, _options, _authenticator| {
|
||||
Err(io::Error::from(io::ErrorKind::Other))
|
||||
});
|
||||
assert_eq!(
|
||||
handler
|
||||
.launch(
|
||||
&test_destination(),
|
||||
&test_options(),
|
||||
&mut test_authenticator()
|
||||
)
|
||||
.await
|
||||
.unwrap_err()
|
||||
.kind(),
|
||||
io::ErrorKind::Other
|
||||
);
|
||||
|
||||
let handler = boxed_launch_handler!(|_destination, _options, _authenticator| async {
|
||||
Err(io::Error::from(io::ErrorKind::Other))
|
||||
});
|
||||
assert_eq!(
|
||||
handler
|
||||
.launch(
|
||||
&test_destination(),
|
||||
&test_options(),
|
||||
&mut test_authenticator()
|
||||
)
|
||||
.await
|
||||
.unwrap_err()
|
||||
.kind(),
|
||||
io::ErrorKind::Other
|
||||
);
|
||||
|
||||
let handler = boxed_launch_handler!(move |_destination, _options, _authenticator| {
|
||||
Err(io::Error::from(io::ErrorKind::Other))
|
||||
});
|
||||
assert_eq!(
|
||||
handler
|
||||
.launch(
|
||||
&test_destination(),
|
||||
&test_options(),
|
||||
&mut test_authenticator()
|
||||
)
|
||||
.await
|
||||
.unwrap_err()
|
||||
.kind(),
|
||||
io::ErrorKind::Other
|
||||
);
|
||||
|
||||
let handler = boxed_launch_handler!(move |_destination, _options, _authenticator| async {
|
||||
Err(io::Error::from(io::ErrorKind::Other))
|
||||
});
|
||||
assert_eq!(
|
||||
handler
|
||||
.launch(
|
||||
&test_destination(),
|
||||
&test_options(),
|
||||
&mut test_authenticator()
|
||||
)
|
||||
.await
|
||||
.unwrap_err()
|
||||
.kind(),
|
||||
io::ErrorKind::Other
|
||||
);
|
||||
}
|
||||
|
||||
#[test(tokio::test)]
|
||||
async fn boxed_connect_handler_should_generate_valid_boxed_connect_handler() {
|
||||
let handler = boxed_connect_handler!(|_destination, _options, _authenticator| {
|
||||
Err(io::Error::from(io::ErrorKind::Other))
|
||||
});
|
||||
assert_eq!(
|
||||
handler
|
||||
.connect(
|
||||
&test_destination(),
|
||||
&test_options(),
|
||||
&mut test_authenticator()
|
||||
)
|
||||
.await
|
||||
.unwrap_err()
|
||||
.kind(),
|
||||
io::ErrorKind::Other
|
||||
);
|
||||
|
||||
let handler = boxed_connect_handler!(|_destination, _options, _authenticator| async {
|
||||
Err(io::Error::from(io::ErrorKind::Other))
|
||||
});
|
||||
assert_eq!(
|
||||
handler
|
||||
.connect(
|
||||
&test_destination(),
|
||||
&test_options(),
|
||||
&mut test_authenticator()
|
||||
)
|
||||
.await
|
||||
.unwrap_err()
|
||||
.kind(),
|
||||
io::ErrorKind::Other
|
||||
);
|
||||
|
||||
let handler = boxed_connect_handler!(move |_destination, _options, _authenticator| {
|
||||
Err(io::Error::from(io::ErrorKind::Other))
|
||||
});
|
||||
assert_eq!(
|
||||
handler
|
||||
.connect(
|
||||
&test_destination(),
|
||||
&test_options(),
|
||||
&mut test_authenticator()
|
||||
)
|
||||
.await
|
||||
.unwrap_err()
|
||||
.kind(),
|
||||
io::ErrorKind::Other
|
||||
);
|
||||
|
||||
let handler = boxed_connect_handler!(move |_destination, _options, _authenticator| async {
|
||||
Err(io::Error::from(io::ErrorKind::Other))
|
||||
});
|
||||
assert_eq!(
|
||||
handler
|
||||
.connect(
|
||||
&test_destination(),
|
||||
&test_options(),
|
||||
&mut test_authenticator()
|
||||
)
|
||||
.await
|
||||
.unwrap_err()
|
||||
.kind(),
|
||||
io::ErrorKind::Other
|
||||
);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue