cosmic-space 0.3.14

the Space portion of starlane as opposed to hyperspace
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use std::collections::HashSet;
use std::ops::{Deref, DerefMut};

use serde::{Deserialize, Serialize};

use cosmic_macros_primitive::Autobox;

use crate::command::common::StateSrc;
use crate::config::mechtron::MechtronConfig;
use crate::err::SpaceErr;
use crate::kind::{Kind, KindParts, StarSub};
use crate::loc::{StarKey, Surface, ToPoint, ToSurface};
use crate::log::Log;
use crate::parse::SkewerCase;
use crate::particle::{Details, Status, Stub};
use crate::selector::KindSelector;
use crate::substance::Substance;
use crate::wave::core::cmd::CmdMethod;
use crate::wave::core::hyp::HypMethod;
use crate::wave::core::{DirectedCore, ReflectedCore};
use crate::wave::{
    Ping, Pong, ReflectedKind, ReflectedProto, ToRecipients, UltraWave, Wave, WaveId, WaveKind,
};
use crate::{Agent, Document};
use crate::point::Point;

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq, strum_macros::Display)]
pub enum AssignmentKind {
    Create,
    // eventually we will have Move as well as Create
}

#[derive(Debug, Clone, Serialize, Deserialize, strum_macros::Display)]
pub enum ChildRegistry {
    Shell,
    Core,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Location {
    Central,
    Nowhere,
    Somewhere(Point),
}

impl ToString for Location {
    fn to_string(&self) -> String {
        match self {
            Location::Nowhere => "Unassigned".to_string(),
            Location::Somewhere(point) => point.to_string(),
            Location::Central => Point::central().to_string(),
        }
    }
}

impl Location {
    pub fn new(point: Point) -> Self {
        Location::Somewhere(point)
    }

    pub fn ok_or(&self) -> Result<Point, SpaceErr> {
        match self {
            Location::Nowhere => Err("Particle is presently nowhere".into()),
            Location::Somewhere(point) => Ok(point.clone()),

            Location::Central => Ok(Point::central()),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ParticleRecord {
    pub details: Details,
    pub location: ParticleLocation,
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct ParticleLocation {
    pub star: Option<Point>,
    pub host: Option<Point>,
}

impl ParticleLocation {
    pub fn new(star: Option<Point>, host: Option<Point>) -> Self {
        Self { star, host }
    }
}

impl From<ParticleLocation> for ReflectedCore {
    fn from(location: ParticleLocation) -> Self {
        let location = Substance::Location(location);
        ReflectedCore::ok_body(location)
    }
}

impl Default for ParticleLocation {
    fn default() -> Self {
        ParticleLocation::new(None, None)
    }
}

impl Default for ParticleRecord {
    fn default() -> Self {
        Self::root()
    }
}

impl ParticleRecord {
    pub fn new(details: Details, location: ParticleLocation) -> Self {
        ParticleRecord { details, location }
    }

    pub fn root() -> Self {
        Self {
            details: Details {
                stub: Stub {
                    point: Point::root(),
                    kind: Kind::Root,
                    status: Status::Ready,
                },
                properties: Default::default(),
            },
            location: Default::default(),
        }
    }
}

impl Into<Stub> for ParticleRecord {
    fn into(self) -> Stub {
        self.details.stub
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct Provision {
    pub point: Point,
    pub state: StateSrc,
}

impl Provision {
    pub fn new(point: Point, state: StateSrc) -> Self {
        Self { point, state }
    }
}

impl TryFrom<Ping> for Provision {
    type Error = SpaceErr;

    fn try_from(request: Ping) -> Result<Self, Self::Error> {
        if let Substance::Hyper(HyperSubstance::Provision(provision)) = request.core.body {
            Ok(provision)
        } else {
            Err(SpaceErr::bad_request(
                "expecting a Provision HyperSubstance",
            ))
        }
    }
}

impl Into<Substance> for Provision {
    fn into(self) -> Substance {
        Substance::Hyper(HyperSubstance::Provision(self))
    }
}

impl Into<DirectedCore> for Provision {
    fn into(self) -> DirectedCore {
        DirectedCore::new(HypMethod::Assign.into())
            .with_body(Substance::Hyper(HyperSubstance::Provision(self)))
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct Assign {
    pub kind: AssignmentKind,
    pub details: Details,
    pub state: StateSrc,
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct HostCmd {
    pub kind: AssignmentKind,
    pub details: Details,
    pub state: StateSrc,
    pub config: MechtronConfig,
}

impl HostCmd {
    pub fn kind(&self) -> &Kind {
        &self.details.stub.kind
    }

    pub fn new(
        kind: AssignmentKind,
        details: Details,
        state: StateSrc,
        config: MechtronConfig,
    ) -> Self {
        Self {
            kind,
            details,
            state,
            config,
        }
    }
}

impl Assign {
    pub fn kind(&self) -> &Kind {
        &self.details.stub.kind
    }

    pub fn new(kind: AssignmentKind, details: Details, state: StateSrc) -> Self {
        Self {
            kind,
            details,
            state,
        }
    }

    pub fn to_host_cmd(self, config: MechtronConfig) -> HostCmd {
        HostCmd {
            kind: self.kind,
            details: self.details,
            state: self.state,
            config,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq, strum_macros::Display, Autobox)]
pub enum HyperSubstance {
    Provision(Provision),
    Assign(Assign),
    Host(HostCmd),
    Event(HyperEvent),
    Log(Log),
    Search(Search),
    Discoveries(Discoveries),
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub enum Search {
    Star(StarKey),
    StarKind(StarSub),
    Kinds,
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct Discovery {
    pub star_kind: StarSub,
    pub hops: u16,
    pub star_key: StarKey,
    pub kinds: HashSet<KindSelector>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct Discoveries {
    pub vec: Vec<Discovery>,
}

impl Discoveries {
    pub fn new() -> Self {
        Self { vec: vec![] }
    }
}

impl Deref for Discoveries {
    type Target = Vec<Discovery>;

    fn deref(&self) -> &Self::Target {
        &self.vec
    }
}

impl DerefMut for Discoveries {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.vec
    }
}

impl TryFrom<Ping> for Assign {
    type Error = SpaceErr;

    fn try_from(request: Ping) -> Result<Self, Self::Error> {
        if let Substance::Hyper(HyperSubstance::Assign(assign)) = request.core.body {
            Ok(assign)
        } else {
            Err(SpaceErr::bad_request("expecting an Assign HyperSubstance"))
        }
    }
}

impl Into<Substance> for Assign {
    fn into(self) -> Substance {
        Substance::Hyper(HyperSubstance::Assign(self))
    }
}

impl Into<DirectedCore> for Assign {
    fn into(self) -> DirectedCore {
        DirectedCore::new(HypMethod::Assign.into())
            .with_body(Substance::Hyper(HyperSubstance::Assign(self)))
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq, strum_macros::Display, Autobox)]
pub enum HyperEvent {
    Created(Created),
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct Created {
    pub point: Point,
    pub kind: KindParts,
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq, strum_macros::Display, Hash)]
pub enum InterchangeKind {
    Singleton,
    DefaultControl,
    Control(ControlPattern),
    Portal(ControlPattern),
    Star(StarKey),
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq, strum_macros::Display, Hash)]
pub enum ControlPattern {
    Any,
    Star(Point),
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct Knock {
    pub kind: InterchangeKind,
    pub auth: Box<Substance>,
    pub remote: Option<Surface>,
}

impl Knock {
    pub fn new(kind: InterchangeKind, remote: Surface, auth: Substance) -> Self {
        Self {
            kind,
            remote: Some(remote),
            auth: Box::new(auth),
        }
    }
}

impl Default for Knock {
    fn default() -> Self {
        Self {
            kind: InterchangeKind::DefaultControl,
            auth: Box::new(Substance::Empty),
            remote: None,
        }
    }
}

impl Into<Wave<Ping>> for Knock {
    fn into(self) -> Wave<Ping> {
        let mut core = DirectedCore::new(HypMethod::Knock.into());
        core.body = Substance::Knock(self);
        let wave = Wave::new(
            Ping::new(core, Point::local_endpoint().to_surface()),
            Point::remote_endpoint().to_surface(),
        );
        wave
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
pub struct Greet {
    pub surface: Surface,
    pub agent: Agent,
    pub hop: Surface,
    pub transport: Surface,
}

impl Greet {
    pub fn new(agent: Agent, surface: Surface, hop: Surface, transport: Surface) -> Self {
        Self {
            agent,
            surface,
            hop,
            transport,
        }
    }
}

impl Into<UltraWave> for Greet {
    fn into(self) -> UltraWave {
        let mut proto = ReflectedProto::new();
        proto.kind(ReflectedKind::Pong);
        proto.agent(Agent::HyperUser);
        proto.from(self.transport.clone());
        proto.to(self.surface.clone());
        proto.intended(self.hop.clone());
        proto.reflection_of(WaveId::new(WaveKind::Ping)); // this is just randomly created since this pong reflection will not be traditionally handled on the receiving end
        proto.status(200u16);
        proto.body(self.into());
        proto.build().unwrap().to_ultra()
    }
}

#[derive(Clone)]
pub enum MountKind {
    Control,
    Portal,
}

impl MountKind {
    pub fn kind(&self) -> Kind {
        match self {
            MountKind::Control => Kind::Control,
            MountKind::Portal => Kind::Portal,
        }
    }
}