+/livesplit-wrapper
git clone https://git.julia.blue/+/livesplit-wrapper
b0170e4
gh-pages
1<!DOCTYPE html >< html lang ="en ">< head >< meta charset ="utf-8 ">< meta name ="viewport "content ="width=device-width, initial-scale=1.0 ">< meta name ="generator "content ="rustdoc ">< meta name ="description "content ="Source of the Rust file `src/process.rs`. ">< meta name ="keywords "content ="rust, rustlang, rust-lang ">< title > process.rs - source</ title >< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../SourceSerif4-Regular.ttf.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../FiraSans-Regular.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../FiraSans-Medium.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../SourceCodePro-Regular.ttf.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../SourceSerif4-Bold.ttf.woff2 ">< link rel ="preload "as ="font "type ="font/woff2 "crossorigin href ="../../SourceCodePro-Semibold.ttf.woff2 ">< link rel ="stylesheet "href ="../../normalize.css ">< link rel ="stylesheet "href ="../../rustdoc.css "id ="mainThemeStyle ">< link rel ="stylesheet "href ="../../ayu.css "disabled >< link rel ="stylesheet "href ="../../dark.css "disabled >< link rel ="stylesheet "href ="../../light.css "id ="themeStyle ">< script id ="default-settings "></ script >< script src ="../../storage.js "></ script >< script defer src ="../../source-script.js "></ script >< script defer src ="../../source-files.js "></ script >< script defer src ="../../main.js "></ script >< noscript >< link rel ="stylesheet "href ="../../noscript.css "></ noscript >< link rel ="alternate icon "type ="image/png "href ="../../favicon-16x16.png ">< link rel ="alternate icon "type ="image/png "href ="../../favicon-32x32.png ">< link rel ="icon "type ="image/svg+xml "href ="../../favicon.svg "></ head >< body class ="rustdoc source "> <!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--> < nav class ="mobile-topbar ">< button class ="sidebar-menu-toggle "> ☰</ button >< a class ="sidebar-logo "href ="../../livesplit_wrapper/index.html ">< div class ="logo-container ">< img src ="https://github.com/LiveSplit.png "alt ="logo "></ div ></ a >< h2 class ="location "></ h2 ></ nav >< nav class ="sidebar ">< a class ="sidebar-logo "href ="../../livesplit_wrapper/index.html ">< div class ="logo-container "> 2< img src ="https://github.com/LiveSplit.png "alt ="logo "></ div ></ a ></ nav >< main >< div class ="width-limiter ">< div class ="sub-container ">< a class ="sub-logo-container "href ="../../livesplit_wrapper/index.html "> 3< img src ="https://github.com/LiveSplit.png "alt ="logo "></ a >< nav class ="sub ">< form class ="search-form ">< div class ="search-container ">< span ></ span >< input class ="search-input "name ="search "autocomplete ="off "spellcheck ="false "placeholder ="Click or press ‘S’ to search, ‘?’ for more options… "type ="search ">< div id ="help-button "title ="help "tabindex ="-1 ">< button type ="button "> ?</ button ></ div >< div id ="settings-menu "tabindex ="-1 ">< a href ="../../settings.html "title ="settings ">< img width ="22 "height ="22 "alt ="Change settings "src ="../../wheel.svg "></ a ></ div ></ div ></ form ></ nav ></ div >< section id ="main-content "class ="content ">< div class ="example-wrap ">< pre class ="line-numbers ">< span id ="1 "> 1</ span > 4< span id ="2 "> 2</ span > 5< span id ="3 "> 3</ span > 6< span id ="4 "> 4</ span > 7< span id ="5 "> 5</ span > 8< span id ="6 "> 6</ span > 9< span id ="7 "> 7</ span > 10< span id ="8 "> 8</ span > 11< span id ="9 "> 9</ span > 12< span id ="10 "> 10</ span > 13< span id ="11 "> 11</ span > 14< span id ="12 "> 12</ span > 15< span id ="13 "> 13</ span > 16< span id ="14 "> 14</ span > 17< span id ="15 "> 15</ span > 18< span id ="16 "> 16</ span > 19< span id ="17 "> 17</ span > 20< span id ="18 "> 18</ span > 21< span id ="19 "> 19</ span > 22< span id ="20 "> 20</ span > 23< span id ="21 "> 21</ span > 24< span id ="22 "> 22</ span > 25< span id ="23 "> 23</ span > 26< span id ="24 "> 24</ span > 27< span id ="25 "> 25</ span > 28< span id ="26 "> 26</ span > 29< span id ="27 "> 27</ span > 30< span id ="28 "> 28</ span > 31< span id ="29 "> 29</ span > 32< span id ="30 "> 30</ span > 33< span id ="31 "> 31</ span > 34< span id ="32 "> 32</ span > 35< span id ="33 "> 33</ span > 36< span id ="34 "> 34</ span > 37< span id ="35 "> 35</ span > 38< span id ="36 "> 36</ span > 39< span id ="37 "> 37</ span > 40< span id ="38 "> 38</ span > 41< span id ="39 "> 39</ span > 42< span id ="40 "> 40</ span > 43< span id ="41 "> 41</ span > 44< span id ="42 "> 42</ span > 45< span id ="43 "> 43</ span > 46< span id ="44 "> 44</ span > 47< span id ="45 "> 45</ span > 48< span id ="46 "> 46</ span > 49< span id ="47 "> 47</ span > 50< span id ="48 "> 48</ span > 51< span id ="49 "> 49</ span > 52< span id ="50 "> 50</ span > 53< span id ="51 "> 51</ span > 54< span id ="52 "> 52</ span > 55< span id ="53 "> 53</ span > 56< span id ="54 "> 54</ span > 57< span id ="55 "> 55</ span > 58< span id ="56 "> 56</ span > 59< span id ="57 "> 57</ span > 60< span id ="58 "> 58</ span > 61< span id ="59 "> 59</ span > 62< span id ="60 "> 60</ span > 63< span id ="61 "> 61</ span > 64< span id ="62 "> 62</ span > 65< span id ="63 "> 63</ span > 66< span id ="64 "> 64</ span > 67< span id ="65 "> 65</ span > 68< span id ="66 "> 66</ span > 69< span id ="67 "> 67</ span > 70< span id ="68 "> 68</ span > 71< span id ="69 "> 69</ span > 72< span id ="70 "> 70</ span > 73< span id ="71 "> 71</ span > 74< span id ="72 "> 72</ span > 75< span id ="73 "> 73</ span > 76< span id ="74 "> 74</ span > 77< span id ="75 "> 75</ span > 78< span id ="76 "> 76</ span > 79< span id ="77 "> 77</ span > 80< span id ="78 "> 78</ span > 81< span id ="79 "> 79</ span > 82< span id ="80 "> 80</ span > 83< span id ="81 "> 81</ span > 84< span id ="82 "> 82</ span > 85< span id ="83 "> 83</ span > 86< span id ="84 "> 84</ span > 87< span id ="85 "> 85</ span > 88< span id ="86 "> 86</ span > 89< span id ="87 "> 87</ span > 90< span id ="88 "> 88</ span > 91< span id ="89 "> 89</ span > 92< span id ="90 "> 90</ span > 93< span id ="91 "> 91</ span > 94< span id ="92 "> 92</ span > 95< span id ="93 "> 93</ span > 96< span id ="94 "> 94</ span > 97< span id ="95 "> 95</ span > 98</ pre >< pre class ="rust ">< code >< span class ="kw "> use</ span > std::mem::{< span class ="self "> self</ span > , MaybeUninit}; 99< span class ="kw "> use</ span > std::slice; 100 101< span class ="kw "> pub use</ span > bytemuck::Pod; 102 103< span class ="kw "> use</ span >< span class ="kw "> super</ span > ::ffi; 104 105< span class ="doccomment "> /// Currently the only possible error is a failed memory read on the attached 106/// process. 107</ span >< span class ="attribute "> #[derive(Debug)] 108</ span >< span class ="kw "> pub enum</ span > Error { 109< span class ="doccomment "> /// A memory read on the attached process failed 110</ span > FailedRead, 111} 112 113< span class ="doccomment "> /// The result of an attempt to read process memory. 114</ span >< span class ="kw "> pub type</ span >< span class ="prelude-ty "> Result</ span > <T> = std::result::Result<T, Error>; 115 116< span class ="doccomment "> /// An address in the attached processes memory. 117/// 118/// Autosplitters can attach to 32-bit processes, they'll just get an error if 119/// they try to read outside it's address space. 120</ span >< span class ="kw "> pub type</ span > Address = u64; 121 122< span class ="doccomment "> /// A handle representing an attached process that can be used to read its 123/// memory. 124</ span >< span class ="attribute "> #[derive(Debug)] 125</ span >< span class ="kw "> pub struct</ span > Process(< span class ="kw "> pub</ span > (< span class ="kw "> crate</ span > ) u64); 126 127< span class ="kw "> impl</ span > Process { 128< span class ="doccomment "> /// Reads a single value from the attached processes memory space. To be 129 /// able to use this with your own types, they need to implement [`Pod`] 130 /// (it's implemented for the numeric types and fixed size arrays by 131 /// default). 132</ span >< span class ="kw "> pub fn</ span > read<T: Pod>(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , addr: Address) ->< span class ="prelude-ty "> Result</ span > <T> { 133< span class ="kw "> unsafe</ span > { 134< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > buf = MaybeUninit::uninit(); 135< span class ="self "> self</ span > .read_into_buf( 136 addr, 137 slice::from_raw_parts_mut(buf.as_mut_ptr()< span class ="kw "> as</ span >< span class ="kw-2 "> *mut</ span > u8, mem::size_of::<T>()), 138 )< span class ="question-mark "> ?</ span > ; 139< span class ="prelude-val "> Ok</ span > (buf.assume_init()) 140 } 141 } 142 143< span class ="doccomment "> /// Search for a module (aka dynamic library) loaded by the attached process 144 /// by name and return its base address. 145</ span >< span class ="kw "> pub fn</ span > module(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , name:< span class ="kw-2 "> &</ span > str) ->< span class ="prelude-ty "> Option</ span > <Address> { 146< span class ="kw "> unsafe</ span > { 147< span class ="kw "> match</ span > ffi::process_get_module_address(< span class ="self "> self</ span > .< span class ="number "> 0</ span > , name.as_ptr()< span class ="kw "> as</ span > u32, name.len()< span class ="kw "> as</ span > u32) { 148< span class ="number "> 0</ span > =>< span class ="prelude-val "> None</ span > , 149 n =>< span class ="prelude-val "> Some</ span > (n), 150 } 151 } 152 } 153 154< span class ="doccomment "> /// Read bytes from the attached processes memory space starting at `addr` 155 /// into `buf`. 156</ span >< span class ="kw "> pub fn</ span > read_into_buf(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , addr: Address, buf:< span class ="kw-2 "> &mut</ span > [u8]) ->< span class ="prelude-ty "> Result</ span > <()> { 157< span class ="kw "> unsafe</ span > { 158 (ffi::process_read(< span class ="self "> self</ span > .< span class ="number "> 0</ span > , addr, buf.as_mut_ptr()< span class ="kw "> as</ span > u32, buf.len()< span class ="kw "> as</ span > u32) !=< span class ="number "> 0</ span > ) 159 .then_some(()) 160 .ok_or(Error::FailedRead) 161 } 162 } 163 164< span class ="doccomment "> /// Reads a null terminated string starting at the given base address. 165 /// Returns an `Error` on a failed read, and panics if no null is 166 /// encountered after 255 bytes or the bytes read are invalid unicode. 167</ span >< span class ="kw "> pub fn</ span > read_cstr(< span class ="kw-2 "> &</ span >< span class ="self "> self</ span > , base: u64) ->< span class ="prelude-ty "> Result</ span > <String> { 168< span class ="kw "> const</ span > MAX_STR_LEN: usize =< span class ="number "> 256</ span > ; 169< span class ="kw "> let</ span >< span class ="kw-2 "> mut</ span > buf =< span class ="macro "> vec!</ span > [< span class ="number "> 0u8</ span > ; MAX_STR_LEN]; 170< span class ="kw "> unsafe</ span > { 171 (ffi::process_read( 172< span class ="self "> self</ span > .< span class ="number "> 0</ span > , 173 base, 174 buf.as_mut_ptr()< span class ="kw "> as</ span > u32, 175 MAX_STR_LEN< span class ="kw "> as</ span > u32 -< span class ="number "> 1</ span > , 176 ) !=< span class ="number "> 0</ span > ) 177 .then_some(()) 178 .ok_or(Error::FailedRead)< span class ="question-mark "> ?</ span > ; 179 } 180 buf.truncate(buf.iter().position(|< span class ="kw-2 "> &</ span > x| x ==< span class ="number "> 0</ span > ).expect(< span class ="string "> "string too long"</ span > ) +< span class ="number "> 1</ span > ); 181< span class ="kw "> let</ span > cstr = std::ffi::CString::from_vec_with_nul(buf).expect(< span class ="string "> "invalid unicode"</ span > ); 182< span class ="prelude-val "> Ok</ span > (cstr.to_string_lossy().to_string()) 183 } 184} 185 186< span class ="kw "> impl</ span > Drop< span class ="kw "> for</ span > Process { 187< span class ="kw "> fn</ span > drop(< span class ="kw-2 "> &mut</ span >< span class ="self "> self</ span > ) { 188< span class ="kw "> unsafe</ span > { 189 ffi::process_detach(< span class ="self "> self</ span > .< span class ="number "> 0</ span > ); 190 } 191 } 192} 193</ code ></ pre ></ div > 194</ section ></ div ></ main >< div id ="rustdoc-vars "data-root-path ="../../ "data-current-crate ="livesplit_wrapper "data-themes ="ayu,dark,light "data-resource-suffix =""data-rustdoc-version ="1.66.0-nightly (4a1467723 2022-09-23) "></ div ></ body ></ html >