[Tracking] rustdocs for public functions of libazureinit

[dongsupark]

Description

Public functions/structs/variables of libazureinit should have own rustdocs. Ideally they should also include example code.

• error (libazureinit: rustdocs for error, http, goalstate, IMDS, unittest #129)

  • Error

• goalstate (libazureinit: rustdocs for error, http, goalstate, IMDS, unittest #129)

  • Goalstate
  • Container
  • RoleInstanceList
  • RoleInstance
  • get_goalstate
  • report_health

• http (libazureinit: rustdocs for error, http, goalstate, IMDS, unittest #129)

  • RETRY_CODES
  • HARDFAIL_CODES
  • IMDS_HTTP_TIMEOUT_SEC
  • WIRESERVER_HTTP_TIMEOUT_SEC

• imds (libazureinit: rustdocs for error, http, goalstate, IMDS, unittest #129)

  • InstanceMetadata
  • Compute
  • OsProfile
  • PublicKeys
  • string_bool
  • query

• media (Add rustdos and intra-doc links to media.rs #144 by @John15321)

  • Environment
  • ProvisioningSection
  • LinuxProvisioningConfigurationSet
  • PlatformSettingsSection
  • PlatformSettings
  • PATH_MOUNT_DEVICE
  • PATH_MOUNT_POINT
  • get_mount_device
  • Mounted
  • Unmounted
  • Media
  • parse_ovf_env
  • mount_parse_ovf_env

• provision/hostname

  • Provisioner

• provision/mod

  • Provision
  • Provision::hostname_provisioners
  • Provision::user_provisioners
  • Provision::password_provisioners
  • Provision::provision

• provision/password

  • Provisioner

• provision/ssh (Add rustdocs to ssh.rs module #147 by @John15321)

  • provision_ssh

• provision/user

  • User
  • User::new
  • User::with_password
  • User::with_groups
  • Provisioner
  • Provisioner::create

• unittest (libazureinit: rustdocs for error, http, goalstate, IMDS, unittest #129)

  • get_http_response_payload
  • serve_requests

[John15321]

#147

Here is a PR for the ssh.rs module @dongsupark