naming, comment fixes

Author: Isaiah Becker-Mayer

crates/ironrdp-client/src/rdp.rs

@@ -193,7 +193,7 @@ async fn active_session(
                         break 'outer;
                     }
                     RdpInputEvent::Clipboard(event) => {
-                        if let Some(cliprdr) = active_stage.get_svc_processor_downcast_ref::<ironrdp::cliprdr::Cliprdr>() {
+                        if let Some(cliprdr) = active_stage.get_svc_processor::<ironrdp::cliprdr::Cliprdr>() {
                             if let Some(svc_messages) = match event {
                                 ClipboardMessage::SendInitiateCopy(formats) => {
                                     Some(cliprdr.initiate_copy(&formats)
@@ -212,7 +212,7 @@ async fn active_session(
                                     None
                                 }
                             } {
-                                let frame = active_stage.process_svc_messages_w_processor(svc_messages)?;
+                                let frame = active_stage.process_svc_messages(svc_messages)?;
                                 // Send the messages to the server
                                 vec![ActiveStageOutput::ResponseFrame(frame)]
                             } else {

crates/ironrdp-cliprdr/src/lib.rs

@@ -8,8 +8,7 @@ pub mod pdu;
 
 use ironrdp_pdu::{decode, gcc::ChannelName, PduResult};
 use ironrdp_svc::{
-    impl_as_any, ChannelFlags, CompressionCondition, StaticVirtualChannelProcessor, SvcMessage,
-    SvcMessagesWithProcessor,
+    impl_as_any, ChannelFlags, CompressionCondition, StaticVirtualChannelProcessor, SvcMessage, SvcMessagesForProcessor,
 };
 use pdu::{
     Capabilities, ClientTemporaryDirectory, ClipboardFormat, ClipboardFormatId, ClipboardGeneralCapabilityFlags,
@@ -23,7 +22,7 @@ use thiserror::Error;
 use tracing::{error, info};
 
 /// PDUs for sending to the server on the CLIPRDR channel.
-pub type CliprdrSvcMessages = SvcMessagesWithProcessor<Cliprdr>;
+pub type CliprdrSvcMessages = SvcMessagesForProcessor<Cliprdr>;
 
 #[derive(Debug, Error)]
 enum ClipboardError {

crates/ironrdp-session/src/active_stage.rs

@@ -8,7 +8,7 @@ use crate::fast_path::UpdateKind;
 use crate::image::DecodedImage;
 use crate::x224::GfxHandler;
 use crate::{fast_path, x224, SessionResult};
-use ironrdp_svc::{StaticVirtualChannelProcessor, SvcMessagesWithProcessor};
+use ironrdp_svc::{StaticVirtualChannelProcessor, SvcMessagesForProcessor};
 
 pub struct ActiveStage {
     x224_processor: x224::Processor,
@@ -94,7 +94,7 @@ impl ActiveStage {
         Ok(output)
     }
 
-    /// Process a frame received from the client.
+    /// Process a frame received from the server.
     pub fn process(
         &mut self,
         image: &mut DecodedImage,
@@ -151,21 +151,21 @@ impl ActiveStage {
         self.x224_processor.encode_static(output, pdu)
     }
 
-    pub fn get_svc_processor_downcast_ref<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&T> {
-        self.x224_processor.get_svc_processor_downcast_ref()
+    pub fn get_svc_processor<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&T> {
+        self.x224_processor.get_svc_processor()
     }
 
-    pub fn get_svc_processor_downcast_mut<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&mut T> {
-        self.x224_processor.get_svc_processor_downcast_mut()
+    pub fn get_svc_processor_mut<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&mut T> {
+        self.x224_processor.get_svc_processor_mut()
     }
 
     /// Completes user's SVC request with data, required to sent it over the network and returns
     /// a buffer with encoded data.
-    pub fn process_svc_messages_w_processor<C: StaticVirtualChannelProcessor + 'static>(
+    pub fn process_svc_messages<C: StaticVirtualChannelProcessor + 'static>(
         &self,
-        request: SvcMessagesWithProcessor<C>,
+        request: SvcMessagesForProcessor<C>,
     ) -> SessionResult<Vec<u8>> {
-        self.x224_processor.process_svc_messages_w_processor(request)
+        self.x224_processor.process_svc_messages(request)
     }
 }
 

crates/ironrdp-session/src/x224/mod.rs

@@ -14,7 +14,7 @@ use ironrdp_pdu::rdp::vc::dvc;
 use ironrdp_pdu::write_buf::WriteBuf;
 use ironrdp_pdu::{encode_buf, mcs};
 use ironrdp_svc::{
-    StaticChannelSet, StaticVirtualChannel, StaticVirtualChannelProcessor, SvcMessage, SvcMessagesWithProcessor,
+    StaticChannelSet, StaticVirtualChannel, StaticVirtualChannelProcessor, SvcMessage, SvcMessagesForProcessor,
 };
 
 pub use self::gfx::GfxHandler;
@@ -62,23 +62,23 @@ impl Processor {
         }
     }
 
-    pub fn get_svc_processor_downcast_ref<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&T> {
+    pub fn get_svc_processor<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&T> {
         self.static_channels
             .get_by_type::<T>()
             .and_then(|svc| svc.channel_processor_downcast_ref())
     }
 
-    pub fn get_svc_processor_downcast_mut<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&mut T> {
+    pub fn get_svc_processor_mut<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&mut T> {
         self.static_channels
             .get_by_type_mut::<T>()
             .and_then(|svc| svc.channel_processor_downcast_mut())
     }
 
     /// Completes user's SVC request with data, required to sent it over the network and returns
     /// a buffer with encoded data.
-    pub fn process_svc_messages_w_processor<C: StaticVirtualChannelProcessor + 'static>(
+    pub fn process_svc_messages<C: StaticVirtualChannelProcessor + 'static>(
         &self,
-        request: SvcMessagesWithProcessor<C>,
+        request: SvcMessagesForProcessor<C>,
     ) -> SessionResult<Vec<u8>> {
         let channel_id = self
             .static_channels

crates/ironrdp-svc/src/lib.rs

@@ -23,13 +23,14 @@ use std::marker::PhantomData;
 pub type StaticChannelId = u16;
 
 /// SVC data to be sent to the server. See [`SvcMessage`] for more information.
+///
 /// Usually returned by the channel-specific methods.
-pub struct SvcMessagesWithProcessor<P: StaticVirtualChannelProcessor> {
+pub struct SvcMessagesForProcessor<P: StaticVirtualChannelProcessor> {
     messages: Vec<SvcMessage>,
     _channel: PhantomData<P>,
 }
 
-impl<P: StaticVirtualChannelProcessor> SvcMessagesWithProcessor<P> {
+impl<P: StaticVirtualChannelProcessor> SvcMessagesForProcessor<P> {
     pub fn new(messages: Vec<SvcMessage>) -> Self {
         Self {
             messages,
@@ -38,20 +39,21 @@ impl<P: StaticVirtualChannelProcessor> SvcMessagesWithProcessor<P> {
     }
 }
 
-impl<P: StaticVirtualChannelProcessor> From<Vec<SvcMessage>> for SvcMessagesWithProcessor<P> {
+impl<P: StaticVirtualChannelProcessor> From<Vec<SvcMessage>> for SvcMessagesForProcessor<P> {
     fn from(messages: Vec<SvcMessage>) -> Self {
         Self::new(messages)
     }
 }
 
-impl<P: StaticVirtualChannelProcessor> From<SvcMessagesWithProcessor<P>> for Vec<SvcMessage> {
-    fn from(request: SvcMessagesWithProcessor<P>) -> Self {
+impl<P: StaticVirtualChannelProcessor> From<SvcMessagesForProcessor<P>> for Vec<SvcMessage> {
+    fn from(request: SvcMessagesForProcessor<P>) -> Self {
         request.messages
     }
 }
 
 /// Encodable PDU to be sent over a static virtual channel.
-/// Additional SVC header flags could be added via [`SvcMessage::with_flags`] method.
+///
+/// Additional SVC header flags can be added via [`SvcMessage::with_flags`] method.
 pub struct SvcMessage {
     pdu: Box<dyn PduEncode>,
     flags: ChannelFlags,
@@ -146,7 +148,7 @@ impl StaticVirtualChannel {
 /// There are at most 31 (optional) static virtual channels that can be created for a single connection, for a
 /// total of 32 static channels when accounting for the non-optional I/O channel.
 pub trait StaticVirtualChannelProcessor: AsAny + fmt::Debug + Send + Sync {
-    /// Returns the name of the `StaticVirtualChannelProcessor`
+    /// Returns the name of the static virtual channel corresponding to this processor.
     fn channel_name(&self) -> ChannelName;
 
     /// Defines which compression flag should be sent along the [`ChannelDef`] Definition Structure (`CHANNEL_DEF`)
@@ -336,8 +338,8 @@ macro_rules! impl_as_any {
     };
 }
 
-/// A set holding at most one [`StaticVirtualChannel`] for any given static channel and
-/// its corresponding [`ChunkProcessor`].
+/// A set holding at most one [`StaticVirtualChannel`] for any given type
+/// implementing [`StaticVirtualChannelProcessor`].
 ///
 /// To ensure uniqueness, each trait object is associated to the [`TypeId`] of it’s original type.
 /// Once joined, channels may have their ID attached using [`Self::attach_channel_id()`], effectively
@@ -373,22 +375,22 @@ impl StaticChannelSet {
         self.channels.insert(TypeId::of::<T>(), StaticVirtualChannel::new(val))
     }
 
-    /// Gets a reference to a [`StaticVirtualChannel`] by looking up its [`TypeId`].
+    /// Gets a reference to a [`StaticVirtualChannel`] by looking up its internal [`StaticVirtualChannelProcessor`]'s [`TypeId`].
     pub fn get_by_type_id(&self, type_id: TypeId) -> Option<&StaticVirtualChannel> {
         self.channels.get(&type_id)
     }
 
-    /// Gets a mutable reference to a [`StaticVirtualChannel`] by looking up its [`TypeId`].
+    /// Gets a mutable reference to a [`StaticVirtualChannel`] by looking up its internal [`StaticVirtualChannelProcessor`]'s [`TypeId`].
     pub fn get_by_type_id_mut(&mut self, type_id: TypeId) -> Option<&mut StaticVirtualChannel> {
         self.channels.get_mut(&type_id)
     }
 
-    /// Gets a reference to a [`StaticVirtualChannel`] by looking up its [`TypeId`].
+    /// Gets a reference to a [`StaticVirtualChannel`] by looking up its internal [`StaticVirtualChannelProcessor`]'s [`TypeId`].
     pub fn get_by_type<T: StaticVirtualChannelProcessor + 'static>(&self) -> Option<&StaticVirtualChannel> {
         self.get_by_type_id(TypeId::of::<T>())
     }
 
-    /// Gets a mutable reference to a [`StaticVirtualChannel`] by looking up its [`TypeId`].
+    /// Gets a mutable reference to a [`StaticVirtualChannel`] by looking up its internal [`StaticVirtualChannelProcessor`]'s [`TypeId`].
     pub fn get_by_type_mut<T: StaticVirtualChannelProcessor + 'static>(&mut self) -> Option<&mut StaticVirtualChannel> {
         self.get_by_type_id_mut(TypeId::of::<T>())
     }