Skip to content

Commit ebe786e

Browse files
committed
win: Add note on how COM port is created
1 parent 69529a7 commit ebe786e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/windows/com.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ impl Drop for OverlappedHandle {
6767
/// should not be instantiated directly by using `COMPort::open()`, instead use
6868
/// the cross-platform `serialport::open()` or
6969
/// `serialport::open_with_settings()`.
70+
///
71+
/// Port is created using `CreateFileW` syscall with following set of flags: `FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED`
7072
#[derive(Debug)]
7173
pub struct COMPort {
7274
handle: HANDLE,

0 commit comments

Comments
 (0)