From 24af17846d14b290aa1d90e37e98c4cbe9e173e1 Mon Sep 17 00:00:00 2001 From: pravic Date: Tue, 12 Apr 2016 18:12:52 +0300 Subject: add winapi-km-rs docs --- doc/km/string/fn.RtlAnsiStringToUnicodeSize.html | 112 +++++++++ doc/km/string/fn.RtlAnsiStringToUnicodeString.html | 112 +++++++++ doc/km/string/fn.RtlCompareString.html | 112 +++++++++ doc/km/string/fn.RtlCompareUnicodeString.html | 112 +++++++++ doc/km/string/fn.RtlEqualString.html | 112 +++++++++ doc/km/string/fn.RtlEqualUnicodeString.html | 112 +++++++++ doc/km/string/fn.RtlFreeAnsiString.html | 112 +++++++++ doc/km/string/fn.RtlFreeUnicodeString.html | 112 +++++++++ doc/km/string/fn.RtlInt64ToUnicodeString.html | 112 +++++++++ doc/km/string/fn.RtlIntegerToUnicodeString.html | 112 +++++++++ doc/km/string/fn.RtlUnicodeStringToAnsiSize.html | 112 +++++++++ doc/km/string/fn.RtlUnicodeStringToAnsiString.html | 112 +++++++++ doc/km/string/fn.RtlUnicodeStringToInteger.html | 112 +++++++++ doc/km/string/index.html | 257 +++++++++++++++++++++ doc/km/string/sidebar-items.js | 1 + doc/km/string/struct.ANSI_STRING.html | 125 ++++++++++ doc/km/string/struct.UNICODE_STRING.html | 129 +++++++++++ doc/km/string/trait.NativeString.html | 133 +++++++++++ doc/km/string/type.AnsiString.html | 112 +++++++++ doc/km/string/type.CONST_ANSI_STRING.html | 112 +++++++++ doc/km/string/type.CONST_UNICODE_STRING.html | 112 +++++++++ doc/km/string/type.UnicodeString.html | 112 +++++++++ 22 files changed, 2549 insertions(+) create mode 100644 doc/km/string/fn.RtlAnsiStringToUnicodeSize.html create mode 100644 doc/km/string/fn.RtlAnsiStringToUnicodeString.html create mode 100644 doc/km/string/fn.RtlCompareString.html create mode 100644 doc/km/string/fn.RtlCompareUnicodeString.html create mode 100644 doc/km/string/fn.RtlEqualString.html create mode 100644 doc/km/string/fn.RtlEqualUnicodeString.html create mode 100644 doc/km/string/fn.RtlFreeAnsiString.html create mode 100644 doc/km/string/fn.RtlFreeUnicodeString.html create mode 100644 doc/km/string/fn.RtlInt64ToUnicodeString.html create mode 100644 doc/km/string/fn.RtlIntegerToUnicodeString.html create mode 100644 doc/km/string/fn.RtlUnicodeStringToAnsiSize.html create mode 100644 doc/km/string/fn.RtlUnicodeStringToAnsiString.html create mode 100644 doc/km/string/fn.RtlUnicodeStringToInteger.html create mode 100644 doc/km/string/index.html create mode 100644 doc/km/string/sidebar-items.js create mode 100644 doc/km/string/struct.ANSI_STRING.html create mode 100644 doc/km/string/struct.UNICODE_STRING.html create mode 100644 doc/km/string/trait.NativeString.html create mode 100644 doc/km/string/type.AnsiString.html create mode 100644 doc/km/string/type.CONST_ANSI_STRING.html create mode 100644 doc/km/string/type.CONST_UNICODE_STRING.html create mode 100644 doc/km/string/type.UnicodeString.html (limited to 'doc/km/string') diff --git a/doc/km/string/fn.RtlAnsiStringToUnicodeSize.html b/doc/km/string/fn.RtlAnsiStringToUnicodeSize.html new file mode 100644 index 0000000..80ca00a --- /dev/null +++ b/doc/km/string/fn.RtlAnsiStringToUnicodeSize.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlAnsiStringToUnicodeSize - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlAnsiStringToUnicodeSize + + [−] + + [src]

+
pub unsafe extern "system" fn RtlAnsiStringToUnicodeSize(SourceString: &CONST_ANSI_STRING) -> u32
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlAnsiStringToUnicodeString.html b/doc/km/string/fn.RtlAnsiStringToUnicodeString.html new file mode 100644 index 0000000..ff96a78 --- /dev/null +++ b/doc/km/string/fn.RtlAnsiStringToUnicodeString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlAnsiStringToUnicodeString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlAnsiStringToUnicodeString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlAnsiStringToUnicodeString(DestinationString: &mut UNICODE_STRING, SourceString: &CONST_ANSI_STRING, AllocateDestination: bool) -> NTSTATUS
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlCompareString.html b/doc/km/string/fn.RtlCompareString.html new file mode 100644 index 0000000..1668198 --- /dev/null +++ b/doc/km/string/fn.RtlCompareString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlCompareString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlCompareString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlCompareString(String1: &CONST_ANSI_STRING, String2: &CONST_ANSI_STRING, CaseInSensitive: bool) -> i32
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlCompareUnicodeString.html b/doc/km/string/fn.RtlCompareUnicodeString.html new file mode 100644 index 0000000..f802f64 --- /dev/null +++ b/doc/km/string/fn.RtlCompareUnicodeString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlCompareUnicodeString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlCompareUnicodeString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlCompareUnicodeString(String1: &CONST_UNICODE_STRING, String2: &CONST_UNICODE_STRING, CaseInSensitive: bool) -> i32
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlEqualString.html b/doc/km/string/fn.RtlEqualString.html new file mode 100644 index 0000000..802c692 --- /dev/null +++ b/doc/km/string/fn.RtlEqualString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlEqualString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlEqualString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlEqualString(String1: &CONST_ANSI_STRING, String2: &CONST_ANSI_STRING) -> bool
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlEqualUnicodeString.html b/doc/km/string/fn.RtlEqualUnicodeString.html new file mode 100644 index 0000000..3862d90 --- /dev/null +++ b/doc/km/string/fn.RtlEqualUnicodeString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlEqualUnicodeString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlEqualUnicodeString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlEqualUnicodeString(String1: &CONST_UNICODE_STRING, String2: &CONST_UNICODE_STRING) -> bool
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlFreeAnsiString.html b/doc/km/string/fn.RtlFreeAnsiString.html new file mode 100644 index 0000000..30d54e2 --- /dev/null +++ b/doc/km/string/fn.RtlFreeAnsiString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlFreeAnsiString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlFreeAnsiString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlFreeAnsiString(UnicodeString: &mut ANSI_STRING)
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlFreeUnicodeString.html b/doc/km/string/fn.RtlFreeUnicodeString.html new file mode 100644 index 0000000..9f8ebc6 --- /dev/null +++ b/doc/km/string/fn.RtlFreeUnicodeString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlFreeUnicodeString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlFreeUnicodeString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlFreeUnicodeString(UnicodeString: &mut UNICODE_STRING)
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlInt64ToUnicodeString.html b/doc/km/string/fn.RtlInt64ToUnicodeString.html new file mode 100644 index 0000000..5b1f954 --- /dev/null +++ b/doc/km/string/fn.RtlInt64ToUnicodeString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlInt64ToUnicodeString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlInt64ToUnicodeString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlInt64ToUnicodeString(Value: u64, Base: u32, String: &mut UNICODE_STRING) -> NTSTATUS
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlIntegerToUnicodeString.html b/doc/km/string/fn.RtlIntegerToUnicodeString.html new file mode 100644 index 0000000..0f5b96e --- /dev/null +++ b/doc/km/string/fn.RtlIntegerToUnicodeString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlIntegerToUnicodeString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlIntegerToUnicodeString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlIntegerToUnicodeString(Value: u32, Base: u32, String: &mut UNICODE_STRING) -> NTSTATUS
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlUnicodeStringToAnsiSize.html b/doc/km/string/fn.RtlUnicodeStringToAnsiSize.html new file mode 100644 index 0000000..89cb195 --- /dev/null +++ b/doc/km/string/fn.RtlUnicodeStringToAnsiSize.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlUnicodeStringToAnsiSize - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlUnicodeStringToAnsiSize + + [−] + + [src]

+
pub unsafe extern "system" fn RtlUnicodeStringToAnsiSize(SourceString: &CONST_UNICODE_STRING) -> u32
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlUnicodeStringToAnsiString.html b/doc/km/string/fn.RtlUnicodeStringToAnsiString.html new file mode 100644 index 0000000..f0a4a5b --- /dev/null +++ b/doc/km/string/fn.RtlUnicodeStringToAnsiString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlUnicodeStringToAnsiString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlUnicodeStringToAnsiString + + [−] + + [src]

+
pub unsafe extern "system" fn RtlUnicodeStringToAnsiString(DestinationString: &mut ANSI_STRING, SourceString: &CONST_UNICODE_STRING, AllocateDestination: bool) -> NTSTATUS
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/fn.RtlUnicodeStringToInteger.html b/doc/km/string/fn.RtlUnicodeStringToInteger.html new file mode 100644 index 0000000..387b96e --- /dev/null +++ b/doc/km/string/fn.RtlUnicodeStringToInteger.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::RtlUnicodeStringToInteger - Rust + + + + + + + + + + + + + + + + + +
+

km::string::RtlUnicodeStringToInteger + + [−] + + [src]

+
pub unsafe extern "system" fn RtlUnicodeStringToInteger(String: &CONST_UNICODE_STRING, Base: u32, Value: &mut u32) -> NTSTATUS
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/index.html b/doc/km/string/index.html new file mode 100644 index 0000000..f11b932 --- /dev/null +++ b/doc/km/string/index.html @@ -0,0 +1,257 @@ + + + + + + + + + + km::string - Rust + + + + + + + + + + + + + + + + + +
+

Module km::string + + [−] + + [src]

+

Kernel mode string types.

+

Structs

+ + + + + + + + +
ANSI_STRING +

A counted string used for ANSI strings.

+
UNICODE_STRING +

A counted Unicode string.

+

Traits

+ + + + +
NativeString +

NT native string types.

+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RtlAnsiStringToUnicodeSize + +
RtlAnsiStringToUnicodeString + +
RtlCompareString + +
RtlCompareUnicodeString + +
RtlEqualString + +
RtlEqualUnicodeString + +
RtlFreeAnsiString + +
RtlFreeUnicodeString + +
RtlInt64ToUnicodeString + +
RtlIntegerToUnicodeString + +
RtlUnicodeStringToAnsiSize + +
RtlUnicodeStringToAnsiString + +
RtlUnicodeStringToInteger + +

Type Definitions

+ + + + + + + + + + + + + + + + +
AnsiString + +
CONST_ANSI_STRING + +
CONST_UNICODE_STRING + +
UnicodeString + +
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/sidebar-items.js b/doc/km/string/sidebar-items.js new file mode 100644 index 0000000..bc1725a --- /dev/null +++ b/doc/km/string/sidebar-items.js @@ -0,0 +1 @@ +initSidebarItems({"fn":[["RtlAnsiStringToUnicodeSize",""],["RtlAnsiStringToUnicodeString",""],["RtlCompareString",""],["RtlCompareUnicodeString",""],["RtlEqualString",""],["RtlEqualUnicodeString",""],["RtlFreeAnsiString",""],["RtlFreeUnicodeString",""],["RtlInt64ToUnicodeString",""],["RtlIntegerToUnicodeString",""],["RtlUnicodeStringToAnsiSize",""],["RtlUnicodeStringToAnsiString",""],["RtlUnicodeStringToInteger",""]],"struct":[["ANSI_STRING","A counted string used for ANSI strings."],["UNICODE_STRING","A counted Unicode string."]],"trait":[["NativeString","NT native string types."]],"type":[["AnsiString",""],["CONST_ANSI_STRING",""],["CONST_UNICODE_STRING",""],["UnicodeString",""]]}); \ No newline at end of file diff --git a/doc/km/string/struct.ANSI_STRING.html b/doc/km/string/struct.ANSI_STRING.html new file mode 100644 index 0000000..8468c08 --- /dev/null +++ b/doc/km/string/struct.ANSI_STRING.html @@ -0,0 +1,125 @@ + + + + + + + + + + km::string::ANSI_STRING - Rust + + + + + + + + + + + + + + + + + +
+

Struct km::string::ANSI_STRING + + [−] + + [src]

+
pub struct ANSI_STRING {
+    pub Length: u16,
+    pub MaximumLength: u16,
+    pub Buffer: *const u8,
+}

A counted string used for ANSI strings.

+

Fields

+ + + +
Length

The length in bytes of the string stored in Buffer.

+
MaximumLength

The length in bytes of Buffer.

+
Buffer

Pointer to a buffer used to contain a string of characters.

+

Trait Implementations

impl<'a> From<&'a [u8]> for ANSI_STRING

fn from(s: &'a [u8]) -> Self

+
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/struct.UNICODE_STRING.html b/doc/km/string/struct.UNICODE_STRING.html new file mode 100644 index 0000000..0bb1613 --- /dev/null +++ b/doc/km/string/struct.UNICODE_STRING.html @@ -0,0 +1,129 @@ + + + + + + + + + + km::string::UNICODE_STRING - Rust + + + + + + + + + + + + + + + + + +
+

Struct km::string::UNICODE_STRING + + [−] + + [src]

+
pub struct UNICODE_STRING {
+    pub Length: u16,
+    pub MaximumLength: u16,
+    pub Buffer: *const u16,
+}

A counted Unicode string.

+

Fields

+ + + +
Length

The length in bytes of the string stored in Buffer.

+
MaximumLength

The length in bytes of Buffer.

+
Buffer

Pointer to a buffer used to contain a string of wide characters.

+

Trait Implementations

impl NativeString for UNICODE_STRING

fn size(&self) -> u16

+

fn max_size(&self) -> u16

+

fn is_empty(&self) -> bool

+

impl Default for UNICODE_STRING

Initializes a counted Unicode string.

+

fn default() -> Self

+
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/trait.NativeString.html b/doc/km/string/trait.NativeString.html new file mode 100644 index 0000000..2938e3b --- /dev/null +++ b/doc/km/string/trait.NativeString.html @@ -0,0 +1,133 @@ + + + + + + + + + + km::string::NativeString - Rust + + + + + + + + + + + + + + + + + +
+

Trait km::string::NativeString + + [−] + + [src]

+
pub trait NativeString {
+    fn size(&self) -> u16;
+    fn max_size(&self) -> u16;
+
+    fn is_empty(&self) -> bool { ... }
+}

NT native string types.

+
+

Required Methods

+
+

fn size(&self) -> u16

Size of string in bytes.

+

fn max_size(&self) -> u16

Size of buffer in bytes.

+
+

Provided Methods

+
+

fn is_empty(&self) -> bool

Check is the string is empty.

+
+

Implementors

+
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/type.AnsiString.html b/doc/km/string/type.AnsiString.html new file mode 100644 index 0000000..dd1e9d4 --- /dev/null +++ b/doc/km/string/type.AnsiString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::AnsiString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::AnsiString + + [−] + + [src]

+
type AnsiString = ANSI_STRING;
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/type.CONST_ANSI_STRING.html b/doc/km/string/type.CONST_ANSI_STRING.html new file mode 100644 index 0000000..0d42de7 --- /dev/null +++ b/doc/km/string/type.CONST_ANSI_STRING.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::CONST_ANSI_STRING - Rust + + + + + + + + + + + + + + + + + +
+

km::string::CONST_ANSI_STRING + + [−] + + [src]

+
type CONST_ANSI_STRING = ANSI_STRING;
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/type.CONST_UNICODE_STRING.html b/doc/km/string/type.CONST_UNICODE_STRING.html new file mode 100644 index 0000000..aa7401a --- /dev/null +++ b/doc/km/string/type.CONST_UNICODE_STRING.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::CONST_UNICODE_STRING - Rust + + + + + + + + + + + + + + + + + +
+

km::string::CONST_UNICODE_STRING + + [−] + + [src]

+
type CONST_UNICODE_STRING = UNICODE_STRING;
+ + +
+ + + + + + + + + + + + \ No newline at end of file diff --git a/doc/km/string/type.UnicodeString.html b/doc/km/string/type.UnicodeString.html new file mode 100644 index 0000000..df7e89f --- /dev/null +++ b/doc/km/string/type.UnicodeString.html @@ -0,0 +1,112 @@ + + + + + + + + + + km::string::UnicodeString - Rust + + + + + + + + + + + + + + + + + +
+

km::string::UnicodeString + + [−] + + [src]

+
type UnicodeString = UNICODE_STRING;
+ + +
+ + + + + + + + + + + + \ No newline at end of file -- cgit v1.2.3