Enum Play

Source
pub enum Play {
    File(String),
    Content(String),
}
Expand description

Represents different sources of playbook content.

The Play enum allows you to specify playbook content either from a file on disk or from a string containing YAML content.

§Examples

§From File

use ansible::Play;

let play = Play::from_file("site.yml");
let play = Play::from_file("/path/to/playbook.yml");

§From Content

use ansible::Play;

let yaml_content = r#"
- hosts: all
  tasks:
    - name: Ensure nginx is installed
      package:
        name: nginx
        state: present
"#;

let play = Play::from_content(yaml_content);

Variants§

§

File(String)

Playbook content loaded from a file path

The file should contain valid YAML playbook content.

§

Content(String)

Playbook content provided as a string

The string should contain valid YAML playbook content.

Implementations§

Source§

impl Play

Source

pub fn from_file(path: impl Into<String>) -> Self

Create a Play from a file path.

This method creates a Play that will read playbook content from the specified file when executed.

§Arguments
  • path - Path to the playbook file (relative or absolute)
§Examples
use ansible::Play;

let play = Play::from_file("site.yml");
let play = Play::from_file("/path/to/playbook.yml");
let play = Play::from_file("playbooks/deploy.yml");
Source

pub fn from_content(content: impl Into<String>) -> Self

Create a Play from string content.

This method creates a Play from YAML content provided as a string. The content will be written to a temporary file when executed.

§Arguments
  • content - YAML playbook content as a string
§Examples
use ansible::Play;

let yaml_content = r#"
- hosts: all
  become: yes
  tasks:
    - name: Update package cache
      apt:
        update_cache: yes
      when: ansible_os_family == "Debian"

    - name: Install essential packages
      package:
        name:
          - curl
          - wget
          - git
        state: present
"#;

let play = Play::from_content(yaml_content);

Trait Implementations§

Source§

impl Clone for Play

Source§

fn clone(&self) -> Play

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 Debug for Play

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Play

§

impl RefUnwindSafe for Play

§

impl Send for Play

§

impl Sync for Play

§

impl Unpin for Play

§

impl UnwindSafe for Play

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.