teeny_core/device/buffer.rs
1/*
2 * Copyright (c) 2026 Teenygrad.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17use crate::{dtype::Num, errors::Result};
18
19/// A device-side memory buffer holding elements of dtype `N`.
20pub trait Buffer<'a, N: Num>: Sized {
21 /// Copy elements from a host slice into this device buffer.
22 /// The slice length must not exceed the buffer's allocated element count.
23 fn to_device(&mut self, src: &[N]) -> Result<()>;
24
25 /// Copy elements from this device buffer into a host slice.
26 /// The slice length must not exceed the buffer's allocated element count.
27 fn to_host(&self, dst: &mut [N]) -> Result<()>;
28}