Struct BackgroundTaskID 

pub struct BackgroundTaskID(/* private fields */);

Unique identifier for a background task, in the bt- form used by Studio apps.

This is the same identity as TaskID, written the way an app sees it. Every Studio app is launched with its own task id in the environment, and Studio surfaces the same id in log URLs (/logs/bt-55b5) and in cloud-batch job names. Parsing that form previously had no home in this client, so each app hand-rolled the hex decode – int(task_id[3:], 16) and similar – reimplementing a format the client is supposed to own and skipping the prefix validation the client would have applied.

Convert to a TaskID to use it with Client::task_info and the other task methods:

use edgefirst_client::{BackgroundTaskID, TaskID};
use std::str::FromStr;

let bt = BackgroundTaskID::from_str("bt-55b5").unwrap();
assert_eq!(bt.value(), 0x55b5);

// Same task, the form the RPC API expects.
let task: TaskID = bt.into();
assert_eq!(task.value(), 0x55b5);
assert_eq!(task.to_string(), "task-55b5");

Implementations

impl BackgroundTaskID

pub fn value(&self) -> u64

Returns the raw u64 value of this identifier.

Trait Implementations

impl Clone for BackgroundTaskID

fn clone(&self) -> BackgroundTaskID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BackgroundTaskID

impl Debug for BackgroundTaskID

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

Formats the value using the given formatter.

impl Default for BackgroundTaskID

fn default() -> BackgroundTaskID

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BackgroundTaskID

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BackgroundTaskID

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

Formats the value using the given formatter.

impl Eq for BackgroundTaskID

impl From<BackgroundTaskID> for u64

fn from(val: BackgroundTaskID) -> Self

Converts to this type from the input type.

impl From<BackgroundTaskID> for TaskID

fn from(id: BackgroundTaskID) -> Self

Converts to this type from the input type.

impl From<TaskID> for BackgroundTaskID

fn from(id: TaskID) -> Self

Converts to this type from the input type.

impl From<u64> for BackgroundTaskID

fn from(id: u64) -> Self

Converts to this type from the input type.

impl FromStr for BackgroundTaskID

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for BackgroundTaskID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BackgroundTaskID

fn eq(&self, other: &BackgroundTaskID) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BackgroundTaskID

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BackgroundTaskID

impl TryFrom<&str> for BackgroundTaskID

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for BackgroundTaskID

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.