crates/nonstick: src/conv.rs annotate

annotate src/conv.rs @ 74:c7c596e6388f

Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) In previous versions of Conversation, you could send messages and then return messages of the wrong type or in the wrong order or whatever. The receiver would then have to make sure that there were the right number of messages and that each message was the right type. That's annoying. This change makes the `Message` enum a two-way channel, where the asker puts their question into it, and then the answerer (the conversation) puts the answer in and returns control to the asker. The asker then only has to pull the Answer of the type they wanted out of the message.

author	Paul Fisher <paul@pfish.zone>
date	Fri, 06 Jun 2025 22:21:17 -0400
parents	ac6881304c78
children	e58d24849e82

rev	line source
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	1 //! The PAM conversation and associated Stuff.
60 05cc2c27334f The Big Refactor: clean up docs and exports. Paul Fisher <paul@pfish.zone> parents: 59 diff changeset	2
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	3 // Temporarily allowed until we get the actual conversation functions hooked up.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	4 #![allow(dead_code)]
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	5
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	6 use crate::constants::Result;
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	7 use crate::ErrorCode;
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	8 use secure_string::SecureString;
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	9 use std::cell::Cell;
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	10
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	11 /// The types of message and request that can be sent to a user.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	12 ///
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	13 /// The data within each enum value is the prompt (or other information)
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	14 /// that will be presented to the user.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	15 pub enum Message<'a> {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	16 MaskedPrompt(&'a MaskedPrompt<'a>),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	17 Prompt(&'a Prompt<'a>),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	18 RadioPrompt(&'a RadioPrompt<'a>),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	19 BinaryPrompt(&'a BinaryPrompt<'a>),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	20 InfoMsg(&'a InfoMsg<'a>),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	21 ErrorMsg(&'a ErrorMsg<'a>),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	22 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	23
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	24 /// A question-and-answer pair that can be communicated in a [`Conversation`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	25 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	26 /// The asking side creates a `QAndA`, then converts it to a [`Message`]
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	27 /// and sends it via a [`Conversation`]. The Conversation then retrieves
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	28 /// the answer to the question (if needed) and sets the response.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	29 /// Once control returns to the asker, the asker gets the answer from this
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	30 /// `QAndA` and uses it however it wants.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	31 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	32 /// For a more detailed explanation of how this works,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	33 /// see [`Conversation::communicate`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	34 pub trait QAndA<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	35 /// The type of the content of the question.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	36 type Question: Copy;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	37 /// The type of the answer to the question.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	38 type Answer;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	39
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	40 /// Converts this Q-and-A pair into a [`Message`] for the [`Conversation`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	41 fn message(&self) -> Message;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	42
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	43 /// The contents of the question being asked.
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	44 ///
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	45 /// For instance, this might say `"Username:"` to prompt the user
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	46 /// for their name.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	47 fn question(&self) -> Self::Question;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	48
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	49 /// Sets the answer to the question.
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	50 ///
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	51 /// The [`Conversation`] implementation calls this to set the answer.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	52 /// The conversation should always call this function, even for messages
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	53 /// that don't have "an answer" (like error or info messages).
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	54 fn set_answer(&self, answer: Result<Self::Answer>);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	55
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	56 /// Gets the answer to the question.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	57 fn answer(self) -> Result<Self::Answer>;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	58 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	59
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	60 macro_rules! q_and_a {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	61 ($name:ident<'a, Q=$qt:ty, A=$at:ty>, $($doc:literal)*) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	62 $(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	63 #[doc = $doc]
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	64 )*
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	65 pub struct $name<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	66 q: $qt,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	67 a: Cell<Result<$at>>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	68 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	69
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	70 impl<'a> QAndA<'a> for $name<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	71 type Question = $qt;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	72 type Answer = $at;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	73
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	74 fn question(&self) -> Self::Question {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	75 self.q
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	76 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	77
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	78 fn set_answer(&self, answer: Result<Self::Answer>) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	79 self.a.set(answer)
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	80 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	81
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	82 fn answer(self) -> Result<Self::Answer> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	83 self.a.into_inner()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	84 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	85
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	86 fn message(&self) -> Message {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	87 Message::$name(self)
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	88 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	89 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	90 };
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	91 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	92
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	93 macro_rules! ask {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	94 ($t:ident) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	95 impl<'a> $t<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	96 #[doc = concat!("Creates a `", stringify!($t), "` to be sent to the user.")]
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	97 fn ask(question: &'a str) -> Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	98 Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	99 q: question,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	100 a: Cell::new(Err(ErrorCode::ConversationError)),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	101 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	102 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	103 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	104 };
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	105 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	106
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	107 q_and_a!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	108 MaskedPrompt<'a, Q=&'a str, A=SecureString>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	109 "Asks the user for data and does not echo it back while being entered."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	110 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	111 "In other words, a password entry prompt."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	112 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	113 ask!(MaskedPrompt);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	114
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	115 q_and_a!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	116 Prompt<'a, Q=&'a str, A=String>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	117 "Asks the user for data."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	118 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	119 "This is the normal \"ask a person a question\" prompt."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	120 "When the user types, their input will be shown to them."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	121 "It can be used for things like usernames."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	122 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	123 ask!(Prompt);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	124
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	125 q_and_a!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	126 RadioPrompt<'a, Q=&'a str, A=String>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	127 "Asks the user for \"radio button\"–style data. (Linux-PAM extension)"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	128 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	129 "This message type is theoretically useful for \"yes/no/maybe\""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	130 "questions, but nowhere in the documentation is it specified"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	131 "what the format of the answer will be, or how this should be shown."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	132 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	133 ask!(RadioPrompt);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	134
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	135 q_and_a!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	136 BinaryPrompt<'a, Q=BinaryQuestion<'a>, A=BinaryData>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	137 "Asks for binary data. (Linux-PAM extension)"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	138 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	139 "This sends a binary message to the client application."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	140 "It can be used to communicate with non-human logins,"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	141 "or to enable things like security keys."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	142 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	143 "The `data_type` tag is a value that is simply passed through"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	144 "to the application. PAM does not define any meaning for it."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	145 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	146 impl<'a> BinaryPrompt<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	147 /// Creates a prompt for the given binary data.
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	148 ///
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	149 /// The `data_type` is a tag you can use for communication between
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	150 /// the module and the application. Its meaning is undefined by PAM.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	151 fn ask(data: &'a [u8], data_type: u8) -> Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	152 Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	153 q: BinaryQuestion { data, data_type },
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	154 a: Cell::new(Err(ErrorCode::ConversationError)),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	155 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	156 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	157 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	158
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	159 /// The contents of a question requesting binary data.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	160 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	161 /// A borrowed version of [`BinaryData`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	162 #[derive(Copy, Clone, Debug)]
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	163 pub struct BinaryQuestion<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	164 data: &'a [u8],
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	165 data_type: u8,
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	166 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	167
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	168 impl BinaryQuestion<'_> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	169 /// Gets the data of this question.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	170 pub fn data(&self) -> &[u8] {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	171 self.data
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	172 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	173
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	174 /// Gets the "type" of this data.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	175 pub fn data_type(&self) -> u8 {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	176 self.data_type
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	177 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	178 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	179
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	180 /// Owned binary data.
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	181 ///
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	182 /// For borrowed data, see [`BinaryQuestion`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	183 /// You can take ownership of the stored data with `.into::<Vec<u8>>()`.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	184 #[derive(Debug, PartialEq)]
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	185 pub struct BinaryData {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	186 data: Vec<u8>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	187 data_type: u8,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	188 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	189
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	190 impl BinaryData {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	191 /// Creates a `BinaryData` with the given contents and type.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	192 pub fn new(data: Vec<u8>, data_type: u8) -> Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	193 Self { data, data_type }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	194 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	195 /// A borrowed view of the data here.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	196 pub fn data(&self) -> &[u8] {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	197 &self.data
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	198 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	199 /// The type of the data stored in this.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	200 pub fn data_type(&self) -> u8 {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	201 self.data_type
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	202 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	203 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	204
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	205 impl From<BinaryData> for Vec<u8> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	206 /// Takes ownership of the data stored herein.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	207 fn from(value: BinaryData) -> Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	208 value.data
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	209 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	210 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	211
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	212 q_and_a!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	213 InfoMsg<'a, Q = &'a str, A = ()>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	214 "A message containing information to be passed to the user."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	215 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	216 "While this does not have an answer, [`Conversation`] implementations"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	217 "should still call [`set_answer`][`QAndA::set_answer`] to verify that"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	218 "the message has been displayed (or actively discarded)."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	219 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	220 impl<'a> InfoMsg<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	221 /// Creates an informational message to send to the user.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	222 fn new(message: &'a str) -> Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	223 Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	224 q: message,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	225 a: Cell::new(Err(ErrorCode::ConversationError)),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	226 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	227 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	228 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	229
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	230 q_and_a!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	231 ErrorMsg<'a, Q = &'a str, A = ()>,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	232 "An error message to be passed to the user."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	233 ""
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	234 "While this does not have an answer, [`Conversation`] implementations"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	235 "should still call [`set_answer`][`QAndA::set_answer`] to verify that"
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	236 "the message has been displayed (or actively discarded)."
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	237
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	238 );
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	239 impl<'a> ErrorMsg<'a> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	240 /// Creates an error message to send to the user.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	241 fn new(message: &'a str) -> Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	242 Self {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	243 q: message,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	244 a: Cell::new(Err(ErrorCode::ConversationError)),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	245 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	246 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	247 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	248
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	249 /// A channel for PAM modules to request information from the user.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	250 ///
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	251 /// This trait is used by both applications and PAM modules:
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	252 ///
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	253 /// - Applications implement Conversation and provide a user interface
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	254 /// to allow the user to respond to PAM questions.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	255 /// - Modules call a Conversation implementation to request information
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	256 /// or send information to the user.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	257 pub trait Conversation {
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	258 /// Sends messages to the user.
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	259 ///
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	260 /// The returned Vec of messages always contains exactly as many entries
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	261 /// as there were messages in the request; one corresponding to each.
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	262 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	263 /// TODO: write detailed documentation about how to use this.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	264 fn communicate(&mut self, messages: &[Message]);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	265 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	266
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	267 /// Turns a simple function into a [`Conversation`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	268 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	269 /// This can be used to wrap a free-floating function for use as a
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	270 /// Conversation:
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	271 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	272 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	273 /// use nonstick::conv::{Conversation, Message, conversation_func};
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	274 /// mod some_library {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	275 /// # use nonstick::Conversation;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	276 /// pub fn get_auth_data(conv: &mut impl Conversation) { /* ... */ }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	277 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	278 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	279 /// fn my_terminal_prompt(messages: &[Message]) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	280 /// // ...
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	281 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	282 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	283 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	284 /// fn main() {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	285 /// some_library::get_auth_data(&mut conversation_func(my_terminal_prompt));
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	286 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	287 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	288 pub fn conversation_func(func: impl FnMut(&[Message])) -> impl Conversation {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	289 Convo(func)
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	290 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	291
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	292 struct Convo<C: FnMut(&[Message])>(C);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	293
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	294 impl<C: FnMut(&[Message])> Conversation for Convo<C> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	295 fn communicate(&mut self, messages: &[Message]) {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	296 self.0(messages)
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	297 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	298 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	299
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	300 /// A conversation trait for asking or answering one question at a time.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	301 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	302 /// An implementation of this is provided for any [`Conversation`],
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	303 /// or a PAM application can implement this trait and handle messages
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	304 /// one at a time.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	305 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	306 /// For example, to use a `Conversation` as a `SimpleConversation`:
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	307 ///
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	308 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	309 /// # use nonstick::{Conversation, Result};
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	310 /// # use secure_string::SecureString;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	311 /// // Bring this trait into scope to get `masked_prompt`, among others.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	312 /// use nonstick::SimpleConversation;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	313 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	314 /// fn ask_for_token(convo: &mut impl Conversation) -> Result<SecureString> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	315 /// convo.masked_prompt("enter your one-time token")
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	316 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	317 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	318 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	319 /// or to use a `SimpleConversation` as a `Conversation`:
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	320 ///
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	321 /// ```
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	322 /// use secure_string::SecureString;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	323 /// use nonstick::{Conversation, SimpleConversation};
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	324 /// # use nonstick::{BinaryData, Result};
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	325 /// mod some_library {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	326 /// # use nonstick::Conversation;
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	327 /// pub fn get_auth_data(conv: &mut impl Conversation) { /* ... */ }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	328 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	329 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	330 /// struct MySimpleConvo { /* ... */ }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	331 /// # impl MySimpleConvo { fn new() -> Self { Self{} } }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	332 ///
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	333 /// impl SimpleConversation for MySimpleConvo {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	334 /// // ...
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	335 /// # fn prompt(&mut self, request: &str) -> Result<String> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	336 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	337 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	338 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	339 /// # fn masked_prompt(&mut self, request: &str) -> Result<SecureString> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	340 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	341 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	342 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	343 /// # fn radio_prompt(&mut self, request: &str) -> Result<String> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	344 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	345 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	346 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	347 /// # fn error_msg(&mut self, message: &str) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	348 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	349 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	350 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	351 /// # fn info_msg(&mut self, message: &str) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	352 /// # todo!()
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	353 /// # }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	354 /// #
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	355 /// # fn binary_prompt(&mut self, data: &[u8], data_type: u8) -> Result<BinaryData> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	356 /// # todo!()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	357 /// # }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	358 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	359 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	360 /// fn main() {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	361 /// let mut simple = MySimpleConvo::new();
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	362 /// some_library::get_auth_data(&mut simple.as_conversation())
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	363 /// }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	364 /// ```
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	365 pub trait SimpleConversation {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	366 /// Lets you use this simple conversation as a full [Conversation].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	367 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	368 /// The wrapper takes each message received in [`Conversation::communicate`]
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	369 /// and passes them one-by-one to the appropriate method,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	370 /// then collects responses to return.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	371 fn as_conversation(&mut self) -> Demux<Self>
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	372 where
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	373 Self: Sized,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	374 {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	375 Demux(self)
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	376 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	377 /// Prompts the user for something.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	378 fn prompt(&mut self, request: &str) -> Result<String>;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	379 /// Prompts the user for something, but hides what the user types.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	380 fn masked_prompt(&mut self, request: &str) -> Result<SecureString>;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	381 /// Prompts the user for a yes/no/maybe conditional (a Linux-PAM extension).
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	382 ///
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	383 /// PAM documentation doesn't define the format of the response.
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	384 fn radio_prompt(&mut self, request: &str) -> Result<String>;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	385 /// Alerts the user to an error.
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	386 fn error_msg(&mut self, message: &str);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	387 /// Sends an informational message to the user.
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	388 fn info_msg(&mut self, message: &str);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	389 /// Requests binary data from the user (a Linux-PAM extension).
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	390 fn binary_prompt(&mut self, data: &[u8], data_type: u8) -> Result<BinaryData>;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	391 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	392
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	393 macro_rules! conv_fn {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	394 ($fn_name:ident($($param:ident: $pt:ty),+) -> $resp_type:ty { $ask:path }) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	395 fn $fn_name(&mut self, $($param: $pt),*) -> Result<$resp_type> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	396 let prompt = $ask($($param),*);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	397 self.communicate(&[prompt.message()]);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	398 prompt.answer()
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	399 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	400 };
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	401 ($fn_name:ident($($param:ident: $pt:ty),+) { $ask:path }) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	402 fn $fn_name(&mut self, $($param: $pt),*) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	403 self.communicate(&[$ask($($param),*).message()]);
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	404 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	405 };
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	406 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	407
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	408 impl<C: Conversation> SimpleConversation for C {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	409 conv_fn!(prompt(message: &str) -> String { Prompt::ask });
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	410 conv_fn!(masked_prompt(message: &str) -> SecureString { MaskedPrompt::ask });
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	411 conv_fn!(radio_prompt(message: &str) -> String { RadioPrompt::ask });
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	412 conv_fn!(error_msg(message: &str) { ErrorMsg::new });
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	413 conv_fn!(info_msg(message: &str) { InfoMsg::new });
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	414 conv_fn!(binary_prompt(data: &[u8], data_type: u8) -> BinaryData { BinaryPrompt::ask });
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	415 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	416
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	417 /// A [`Conversation`] which asks the questions one at a time.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	418 ///
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	419 /// This is automatically created by [`SimpleConversation::as_conversation`].
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	420 pub struct Demux<'a, SC: SimpleConversation>(&'a mut SC);
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	421
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	422 impl<SC: SimpleConversation> Conversation for Demux<'_, SC> {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	423 fn communicate(&mut self, messages: &[Message]) {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	424 for msg in messages {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	425 match msg {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	426 Message::Prompt(prompt) => prompt.set_answer(self.0.prompt(prompt.question())),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	427 Message::MaskedPrompt(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	428 prompt.set_answer(self.0.masked_prompt(prompt.question()))
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	429 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	430 Message::RadioPrompt(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	431 prompt.set_answer(self.0.radio_prompt(prompt.question()))
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	432 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	433 Message::InfoMsg(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	434 self.0.info_msg(prompt.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	435 prompt.set_answer(Ok(()))
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	436 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	437 Message::ErrorMsg(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	438 self.0.error_msg(prompt.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	439 prompt.set_answer(Ok(()))
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	440 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	441 Message::BinaryPrompt(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	442 let q = prompt.question();
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	443 prompt.set_answer(self.0.binary_prompt(q.data, q.data_type))
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	444 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	445 }
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	446 }
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	447 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	448 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	449
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	450 #[cfg(test)]
71 58f9d2a4df38 Reorganize everything again??? Paul Fisher <paul@pfish.zone> parents: 70 diff changeset	451 mod tests {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	452 use super::{
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	453 BinaryPrompt, Conversation, ErrorMsg, InfoMsg, MaskedPrompt, Message, Prompt, QAndA,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	454 RadioPrompt, Result, SecureString, SimpleConversation,
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	455 };
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	456 use crate::constants::ErrorCode;
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	457 use crate::BinaryData;
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	458
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	459 #[test]
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	460 fn test_demux() {
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	461 #[derive(Default)]
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	462 struct DemuxTester {
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	463 error_ran: bool,
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	464 info_ran: bool,
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	465 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	466
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	467 impl SimpleConversation for DemuxTester {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	468 fn prompt(&mut self, request: &str) -> Result<String> {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	469 match request {
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	470 "what" => Ok("whatwhat".to_owned()),
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	471 "give_err" => Err(ErrorCode::PermissionDenied),
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	472 _ => panic!("unexpected prompt!"),
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	473 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	474 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	475 fn masked_prompt(&mut self, request: &str) -> Result<SecureString> {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	476 assert_eq!("reveal", request);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	477 Ok(SecureString::from("my secrets"))
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	478 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	479 fn radio_prompt(&mut self, request: &str) -> Result<String> {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	480 assert_eq!("channel?", request);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	481 Ok("zero".to_owned())
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	482 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	483 fn error_msg(&mut self, message: &str) {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	484 self.error_ran = true;
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	485 assert_eq!("whoopsie", message);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	486 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	487 fn info_msg(&mut self, message: &str) {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	488 self.info_ran = true;
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	489 assert_eq!("did you know", message);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	490 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	491 fn binary_prompt(&mut self, data: &[u8], data_type: u8) -> Result<BinaryData> {
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	492 assert_eq!(&[10, 9, 8], data);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	493 assert_eq!(66, data_type);
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	494 Ok(BinaryData::new(vec![5, 5, 5], 5))
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	495 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	496 }
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	497
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	498 let mut tester = DemuxTester::default();
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	499
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	500 let what = Prompt::ask("what");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	501 let pass = MaskedPrompt::ask("reveal");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	502 let err = ErrorMsg::new("whoopsie");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	503 let info = InfoMsg::new("did you know");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	504 let has_err = Prompt::ask("give_err");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	505
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	506 let mut conv = tester.as_conversation();
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	507
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	508 // Basic tests.
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	509
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	510 conv.communicate(&[
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	511 what.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	512 pass.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	513 err.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	514 info.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	515 has_err.message(),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	516 ]);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	517
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	518 assert_eq!("whatwhat", what.answer().unwrap());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	519 assert_eq!(SecureString::from("my secrets"), pass.answer().unwrap());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	520 assert_eq!(Ok(()), err.answer());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	521 assert_eq!(Ok(()), info.answer());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	522 assert_eq!(ErrorCode::PermissionDenied, has_err.answer().unwrap_err());
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	523 assert!(tester.error_ran);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	524 assert!(tester.info_ran);
9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	525
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	526 // Test the Linux extensions separately.
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	527
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	528 let mut conv = tester.as_conversation();
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	529
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	530 let radio = RadioPrompt::ask("channel?");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	531 let bin = BinaryPrompt::ask(&[10, 9, 8], 66);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	532 conv.communicate(&[radio.message(), bin.message()]);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	533
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	534 assert_eq!("zero", radio.answer().unwrap());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	535 assert_eq!(BinaryData::new(vec![5, 5, 5], 5), bin.answer().unwrap());
70 9f8381a1c09c Implement low-level conversation primitives. Paul Fisher <paul@pfish.zone> parents: 69 diff changeset	536 }
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	537
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	538 fn test_mux() {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	539 struct MuxTester;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	540
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	541 impl Conversation for MuxTester {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	542 fn communicate(&mut self, messages: &[Message]) {
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	543 if let [msg] = messages {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	544 match *msg {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	545 Message::InfoMsg(info) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	546 assert_eq!("let me tell you", info.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	547 info.set_answer(Ok(()))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	548 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	549 Message::ErrorMsg(error) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	550 assert_eq!("oh no", error.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	551 error.set_answer(Ok(()))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	552 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	553 Message::Prompt(prompt) => prompt.set_answer(match prompt.question() {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	554 "should_err" => Err(ErrorCode::PermissionDenied),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	555 "question" => Ok("answer".to_owned()),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	556 other => panic!("unexpected question {other:?}"),
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	557 }),
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	558 Message::MaskedPrompt(ask) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	559 assert_eq!("password!", ask.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	560 ask.set_answer(Ok("open sesame".into()))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	561 }
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	562 Message::BinaryPrompt(prompt) => {
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	563 assert_eq!(&[1, 2, 3], prompt.question().data);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	564 assert_eq!(69, prompt.question().data_type);
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	565 prompt.set_answer(Ok(BinaryData::new(vec![3, 2, 1], 42)))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	566 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	567 Message::RadioPrompt(ask) => {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	568 assert_eq!("radio?", ask.question());
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	569 ask.set_answer(Ok("yes".to_owned()))
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	570 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	571 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	572 } else {
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	573 panic!(
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	574 "there should only be one message, not {len}",
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	575 len = messages.len()
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	576 )
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	577 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	578 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	579 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	580
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	581 let mut tester = MuxTester;
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	582
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	583 assert_eq!("answer", tester.prompt("question").unwrap());
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	584 assert_eq!(
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	585 SecureString::from("open sesame"),
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	586 tester.masked_prompt("password!").unwrap()
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	587 );
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	588 tester.error_msg("oh no");
c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	589 tester.info_msg("let me tell you");
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	590 {
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	591 assert_eq!("yes", tester.radio_prompt("radio?").unwrap());
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	592 assert_eq!(
74 c7c596e6388f Make conversations type-safe (last big reorg) (REAL) (NOT CLICKBAIT) Paul Fisher <paul@pfish.zone> parents: 73 diff changeset	593 BinaryData::new(vec![3, 2, 1], 42),
73 ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	594 tester.binary_prompt(&[1, 2, 3], 69).unwrap(),
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	595 )
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	596 }
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	597 assert_eq!(
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	598 ErrorCode::BufferError,
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	599 tester.prompt("should_error").unwrap_err(),
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	600 );
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	601 assert_eq!(
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	602 ErrorCode::ConversationError,
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	603 tester.masked_prompt("return_wrong_type").unwrap_err()
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	604 )
ac6881304c78 Do conversations, along with way too much stuff. Paul Fisher <paul@pfish.zone> parents: 72 diff changeset	605 }
69 8f3ae0c7ab92 Rework conversation data types and make safe wrappers. Paul Fisher <paul@pfish.zone> parents: 64 diff changeset	606 }

Mercurial > crates > nonstick

annotate src/conv.rs @ 74:c7c596e6388f