Struct StackLayoutBuilder

Source
pub struct StackLayoutBuilder<'a> { /* private fields */ }
Expand description

Builder to create a stack layout as described by the StackLayoutRef type.

Implementations§

Source§

impl<'a> StackLayoutBuilder<'a>

Source

pub const fn new() -> Self

Creates a mew bioöder-

Examples found in repository?
examples/minimal_builder.rs (line 28)
27fn main() {
28    let builder = StackLayoutBuilder::new()
29        // can contain terminating zero; not mandatory in the builder
30        .add_argv("foo")
31        .add_argv("hello")
32        .add_envv("PATH=/bin")
33        .add_auxv(AuxVar::ExecFn("/usr/bin/foo".into()));
34
35    let layout = builder.build(None /* we create the layout in our address space */);
36    let layout = StackLayoutRef::new(layout.as_ref(), None);
37
38    // SAFETY: This is safe as all pointers point into our address space.
39    for (i, arg) in unsafe { layout.argv_iter() }.enumerate() {
40        println!("  [{i}] {}", arg.to_str().unwrap());
41    }
42}
Source

pub fn add_argv(self, arg: impl Into<String>) -> Self

Adds an argument to the builder.

Adding a terminating NUL byte is not necessary. Interim NUL bytes are prohibited.

Examples found in repository?
examples/minimal_builder.rs (line 30)
27fn main() {
28    let builder = StackLayoutBuilder::new()
29        // can contain terminating zero; not mandatory in the builder
30        .add_argv("foo")
31        .add_argv("hello")
32        .add_envv("PATH=/bin")
33        .add_auxv(AuxVar::ExecFn("/usr/bin/foo".into()));
34
35    let layout = builder.build(None /* we create the layout in our address space */);
36    let layout = StackLayoutRef::new(layout.as_ref(), None);
37
38    // SAFETY: This is safe as all pointers point into our address space.
39    for (i, arg) in unsafe { layout.argv_iter() }.enumerate() {
40        println!("  [{i}] {}", arg.to_str().unwrap());
41    }
42}
Source

pub fn add_envv(self, env: impl Into<String>) -> Self

Adds an environment-variable to the builder.

Adding a terminating NUL byte is not necessary. Interim NUL bytes are prohibited.

The value must follow the key=value syntax, where value may be empty.

Examples found in repository?
examples/minimal_builder.rs (line 32)
27fn main() {
28    let builder = StackLayoutBuilder::new()
29        // can contain terminating zero; not mandatory in the builder
30        .add_argv("foo")
31        .add_argv("hello")
32        .add_envv("PATH=/bin")
33        .add_auxv(AuxVar::ExecFn("/usr/bin/foo".into()));
34
35    let layout = builder.build(None /* we create the layout in our address space */);
36    let layout = StackLayoutRef::new(layout.as_ref(), None);
37
38    // SAFETY: This is safe as all pointers point into our address space.
39    for (i, arg) in unsafe { layout.argv_iter() }.enumerate() {
40        println!("  [{i}] {}", arg.to_str().unwrap());
41    }
42}
Source

pub fn add_auxv(self, aux: AuxVar<'a>) -> Self

Adds an AuxVar to the builder.

Examples found in repository?
examples/minimal_builder.rs (line 33)
27fn main() {
28    let builder = StackLayoutBuilder::new()
29        // can contain terminating zero; not mandatory in the builder
30        .add_argv("foo")
31        .add_argv("hello")
32        .add_envv("PATH=/bin")
33        .add_auxv(AuxVar::ExecFn("/usr/bin/foo".into()));
34
35    let layout = builder.build(None /* we create the layout in our address space */);
36    let layout = StackLayoutRef::new(layout.as_ref(), None);
37
38    // SAFETY: This is safe as all pointers point into our address space.
39    for (i, arg) in unsafe { layout.argv_iter() }.enumerate() {
40        println!("  [{i}] {}", arg.to_str().unwrap());
41    }
42}
Source

pub fn build(self, target_addr: Option<usize>) -> ABox<[u8]>

Builds the layout with heap-allocated memory.

§Arguments
  • target_addr: The address the stack layout in the target address space. This may be a user-space address of another process. If this is None then the address of the buffer will be used.
Examples found in repository?
examples/minimal_builder.rs (line 35)
27fn main() {
28    let builder = StackLayoutBuilder::new()
29        // can contain terminating zero; not mandatory in the builder
30        .add_argv("foo")
31        .add_argv("hello")
32        .add_envv("PATH=/bin")
33        .add_auxv(AuxVar::ExecFn("/usr/bin/foo".into()));
34
35    let layout = builder.build(None /* we create the layout in our address space */);
36    let layout = StackLayoutRef::new(layout.as_ref(), None);
37
38    // SAFETY: This is safe as all pointers point into our address space.
39    for (i, arg) in unsafe { layout.argv_iter() }.enumerate() {
40        println!("  [{i}] {}", arg.to_str().unwrap());
41    }
42}

Trait Implementations§

Source§

impl<'a> Clone for StackLayoutBuilder<'a>

Source§

fn clone(&self) -> StackLayoutBuilder<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for StackLayoutBuilder<'a>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for StackLayoutBuilder<'a>

Source§

fn default() -> StackLayoutBuilder<'a>

Returns the “default value” for a type. Read more
Source§

impl<'a> PartialEq for StackLayoutBuilder<'a>

Source§

fn eq(&self, other: &StackLayoutBuilder<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> Eq for StackLayoutBuilder<'a>

Source§

impl<'a> StructuralPartialEq for StackLayoutBuilder<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for StackLayoutBuilder<'a>

§

impl<'a> RefUnwindSafe for StackLayoutBuilder<'a>

§

impl<'a> !Send for StackLayoutBuilder<'a>

§

impl<'a> !Sync for StackLayoutBuilder<'a>

§

impl<'a> Unpin for StackLayoutBuilder<'a>

§

impl<'a> UnwindSafe for StackLayoutBuilder<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.