diff --git a/aya/src/programs/mod.rs b/aya/src/programs/mod.rs index 8d708854..122a52d8 100644 --- a/aya/src/programs/mod.rs +++ b/aya/src/programs/mod.rs @@ -396,7 +396,9 @@ impl Program { } } - /// Returns ProgramInfo for a program. + /// Returns infomation about a program. + /// + /// Returns [None](`std::option::Option::None`) when the program does not have a file descriptor (most likely because it isn't loaded). pub fn info(&self) -> Option> { match self { Program::KProbe(p) => p.info(), @@ -730,6 +732,8 @@ macro_rules! impl_info { $( impl $struct_name { /// Returns a ProgramInfo for this Program. + /// + /// Returns [None](`std::option::Option::None`) when the program does not have a file descriptor (most likely because it isn't loaded). pub fn info(&self) -> Option> { self.data.fd.map(|fd| ProgramInfo::from_fd(&fd)) }