Skip to main content

Section

Struct Section 

Source
pub struct Section {
    pub id: u64,
    pub course_id: Option<u64>,
    pub name: Option<String>,
    pub sis_section_id: Option<String>,
    pub integration_id: Option<String>,
    pub sis_import_id: Option<u64>,
    pub start_at: Option<DateTime<Utc>>,
    pub end_at: Option<DateTime<Utc>>,
    pub restrict_enrollments_to_section_dates: Option<bool>,
    pub nonxlist_course_id: Option<u64>,
    pub total_students: Option<u64>,
    /* private fields */
}
Expand description

A section within a Canvas course.

Fields§

§id: u64§course_id: Option<u64>§name: Option<String>§sis_section_id: Option<String>§integration_id: Option<String>§sis_import_id: Option<u64>§start_at: Option<DateTime<Utc>>§end_at: Option<DateTime<Utc>>§restrict_enrollments_to_section_dates: Option<bool>§nonxlist_course_id: Option<u64>§total_students: Option<u64>

Implementations§

Source§

impl Section

Source

pub async fn edit(&self, params: UpdateSectionParams) -> Result<Section>

Update this section’s name or dates.

§Canvas API

PUT /api/v1/sections/:id

Source

pub async fn delete(&self) -> Result<Section>

Delete this section.

§Canvas API

DELETE /api/v1/sections/:id

Source

pub async fn enroll_user(&self, params: EnrollUserParams) -> Result<Enrollment>

Enroll a user in this section.

§Canvas API

POST /api/v1/sections/:section_id/enrollments

Source

pub fn get_enrollments(&self) -> PageStream<Enrollment>

Stream all enrollments in this section.

§Canvas API

GET /api/v1/sections/:section_id/enrollments

Source

pub async fn cross_list_section(&self, new_course_id: u64) -> Result<Section>

Move this section to another course (cross-list).

§Canvas API

POST /api/v1/sections/:id/crosslist/:new_course_id

Source

pub async fn decross_list_section(&self) -> Result<Section>

Undo cross-listing of this section.

§Canvas API

DELETE /api/v1/sections/:id/crosslist

Source

pub async fn get_assignment_override(&self, assignment_id: u64) -> Result<Value>

Get the assignment override for a specific assignment in this section.

§Canvas API

GET /api/v1/sections/:course_section_id/assignments/:assignment_id/override

Source

pub fn get_multiple_submissions(&self) -> PageStream<Submission>

Stream submissions for multiple assignments in this section.

§Canvas API

GET /api/v1/sections/:section_id/students/submissions

Source

pub async fn submissions_bulk_update( &self, params: &[(String, String)], ) -> Result<Progress>

Bulk-update grades for this section asynchronously.

§Canvas API

POST /api/v1/sections/:section_id/submissions/update_grades

Trait Implementations§

Source§

impl Clone for Section

Source§

fn clone(&self) -> Section

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Section

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Section

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Section

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,