diff options
author | Jesse Luehrs <doy@tozt.net> | 2021-12-30 23:14:55 -0500 |
---|---|---|
committer | Jesse Luehrs <doy@tozt.net> | 2021-12-30 23:14:55 -0500 |
commit | 09ff545fe44242734d5f6daf4a74946d2f04728d (patch) | |
tree | 79e5b7080dd58137020748fcaf15fb089493b864 /src/blocking/pty.rs | |
parent | a5b7f59b19052b69f3ada89e4b07c1fb6dbfaf34 (diff) | |
download | pty-process-09ff545fe44242734d5f6daf4a74946d2f04728d.tar.gz pty-process-09ff545fe44242734d5f6daf4a74946d2f04728d.zip |
docs
Diffstat (limited to 'src/blocking/pty.rs')
-rw-r--r-- | src/blocking/pty.rs | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/src/blocking/pty.rs b/src/blocking/pty.rs index d864bd6..6fa3382 100644 --- a/src/blocking/pty.rs +++ b/src/blocking/pty.rs @@ -1,9 +1,14 @@ +/// An allocated pty pub struct Pty { pt: std::fs::File, pts: std::fs::File, } impl Pty { + /// Allocate and return a new pty. + /// + /// # Errors + /// Returns an error if the pty failed to be allocated. pub fn new() -> crate::Result<Self> { let (pt, ptsname) = crate::sys::create_pt()?; let pts = std::fs::OpenOptions::new() @@ -13,6 +18,10 @@ impl Pty { Ok(Self { pt, pts }) } + /// Change the terminal size associated with the pty. + /// + /// # Errors + /// Returns an error if we were unable to set the terminal size. pub fn resize(&self, size: crate::Size) -> crate::Result<()> { Ok(crate::sys::set_term_size(self, size)?) } |